docsite-cli v1.0.8

A doc tool based on docsify

Not Maintaned!

Please use: https://github.com/hoperyy/qute-cli

order:

• q docsite-init
• q docsite-serve
• q docsite-push
• q docsite-clear

Install

npm i docsite-cli -g

or

npm i docsite-cli --save

demo

https://hoperyy.github.io/snippets/#/

Orders

• docsite serve [targetPath] [-m, --multi] [-i, --show-index]

  Lanch current directory as a website.

  • [-m, --multi]

    Each subdirectory will be lanched as a single website by default

  • [-i, --show-index]

    If dirname matches /^\d*-/, such as 0-README.md, the site will not show 0- but show README by default.

    If you want to show 0-, just add this param.

  • [targetPath]

    target directory. ./ by default

• docsite push [branch] [-m, --multi] [-i, --show-index] (beta and take care!)

  It will push current directory to github.

  • branch

    The target remote git branch. gh-pages by default.

  • [-m, --multi]

    Each subdirectory will be lanched as a single website by default

  • [-i, --show-index]

    If dirname matches /^\d*-/, such as 0-README.md, the site will not show 0- but show README by default.

    If you want to show 0-, just add this param.

• project config files

  • .repo Tell docsite what is this project's repo
  • .sidebarshowignore files that should not be shown in sidebar (It will be reached by url)
  • .sidebarfileignore files that should not be created when creating docsite website (It will not be reached by url)
  • .navbarignore files that should not be shown in navbar
  • README.md project readme.
  • _sidebar.md user defined sidebar. Only work in default mode, not --multi mode
  • _navbar.md user defined navbar. Only work in default mode, not --multi mode

LICENSE

MIT