Drop-in customizable project page, API documentation, and Github Pages support for your npm module.
Builds the docs using the build
command, and then commits them to your
gh-pages
branch:
my-project$ docify publish
my-project$ git checkout gh-pages
my-project$ git status
# On branch master
# Your branch is ahead of 'origin/gh-pages' by 1 commit.
#
nothing to commit (working directory clean)
Note: the publish command won't actually push your gh-pages branch. You'll still need to do that manually.
The publish
commands assumes a few things about your project are aleady
setup:
docs-dist/
by default) added to your
.gitignore
file.test