Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add options to generate docs with sidebar, navbar and coverpage #104

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

WesleyGoncalves
Copy link

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.

Copy link
Member

@sy-records sy-records left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you for your contribution.

Copy link
Member

@jamesgeorge007 jamesgeorge007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to prompt the user to choose between the templates he/she intends to have.

@sy-records
Copy link
Member

What template? _sidebar.md these?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants