Skip to content

jariz-forks/date-fns-dash-docset

 
 

Repository files navigation

date-fns Dash Docs

date-fns documentation for Dash


date-fns in Dash

Install Locally

The easiest way to install this is definitely through Dash, but you can also install locally. To do so, download date-fns.tgz and extract it.

👉 Download Here 👈

Then in Dash go to:

Preferences > Docsets > + (the plus sign in the lower left) > Add Local Docset

Then chose date-fns.docset from the folder where you extracted it. You're all set. Just star the repo and you're done 😉.

Build

Install dependencies

You will need:

  • yarn

Easiest option is probably brew:

Now, to build:

make

Or to rebuild:

make clean build

You can also operate in debug mode with:

DEBUG=true make clean build

This will just make the script process a few pages so that you can get a sense of whether or not everything is working as it should.

Update

make update_and_publish

This will NOT publish anything unless a new version is detected. The script will check the current version sitting in dist against the latest version on NPM. Of course this is error prone of you've never built on the host system before, since the new build will place the latest docset in dist. In that case just run make clean build && ./publish.sh.

Possible Issues

I've disabled JS in the docs since it's not needed now that I rendered everything out to static files. However, the live site is built with React, and the app also queries firebase to download version numbers. None of that is happening in the docs but it's possible issues might arise from such JS-heavy docs running without JS.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 66.7%
  • Shell 18.1%
  • Makefile 15.2%