docsify-cli icon indicating copy to clipboard operation
docsify-cli copied to clipboard

Add options to generate docs with sidebar, navbar and coverpage

Open WesleyGoncalves opened this issue 4 years ago • 1 comments

When I create documentations with docsify, I like to include the coverpage, sidebar and navbar features to take advantage of these amazing resources. So, I decided to automate this process creating options to the init command to include these templates.

So, you can include coverpage, for example, using this command

docsify init ./ --coverpage

# or short
docsify init ./ -c
docsify init <path> [--local false] [--theme vue] [--sidebar false] [--navbar false] [--coverpage false]
docsify init <path> [-l false] [-t vue] [-s false] [-n false] [-c false]

CHANGES

  • lib/cli.js
  • lib/commands/init.js
  • Docs:
    • docs/README.md
    • tools/locale/en.json
  • Add templates _coverpage.md, _sidebar.md, and _navbar.md files to lib/template

I hope that helps docsify users.

WesleyGoncalves avatar Apr 26 '20 23:04 WesleyGoncalves

What template? _sidebar.md these?

sy-records avatar Nov 01 '20 01:11 sy-records