Skip to content

Instantly share code, notes, and snippets.

@developit

developit/instant-documentation-publish.sh

Last active September 26, 2024 22:57
Show Gist options
  • Save developit/04ad7ac878b5fa35e76e to your computer and use it in GitHub Desktop.
Save developit/04ad7ac878b5fa35e76e to your computer and use it in GitHub Desktop.
Download ZIP
Publish your docs instantly using gist & documentation-viewer
Raw
instant-documentation-publish.sh
# SETUP: install documentation.js:
npm i -g documentation browser-pipe
# SETUP: install gist cli (github.com/defunkt/gist)
brew install gist
# generate docs, upload to gist.github.com, then pipe the Gist URL to Documentation Viewer in your browser:
documentation src | gist -p -f docs.json | awk '{print "https://documentation-viewer.firebaseapp.com/#"$1}' | browser-pipe
@developit
Copy link
Author

Gist CLI: defunkt/gist
Documentation Viewer: documentation-viewer.firebaseapp.com (developit/documentation-viewer)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment