FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add options to generate docs with sidebar, navbar and coverpage by WesleyGoncalves · Pull Request #104 · docsifyjs/docsify-cli · GitHub

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

Open
WesleyGoncalves wants to merge 9 commits into
docsifyjs:masterfrom
WesleyGoncalves:master
Open

Add options to generate docs with sidebar, navbar and coverpage#104
WesleyGoncalves wants to merge 9 commits into
docsifyjs:masterfrom
WesleyGoncalves:master

Conversation

Copy link
Copy Markdown

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.

sy-records left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM. Thank you for your contribution.

jamesgeorge007 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Copy link
Copy Markdown
Member

What template? _sidebar.md these?

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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


Back | FazBrowse Home | New Git URL