-
-
Notifications
You must be signed in to change notification settings - Fork 159
Add options to generate docs with sidebar, navbar and coverpage #104
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
Open
Conversation
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
Optionally include sidebar when creating new docs
Optionally include navbar when creating new docs
Optionally include coverpage when creating new docs
sy-records
sy-records
approved these changes
Oct 30, 2020
There was a problem hiding this 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.
There was a problem hiding this 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.
What template? _sidebar.md these?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
initcommand to include these templates.So, you can include coverpage, for example, using this command
docsify init ./ --coverpage # or short docsify init ./ -cCHANGES
lib/cli.jslib/commands/init.jsdocs/README.mdtools/locale/en.json_coverpage.md,_sidebar.md, and_navbar.mdfiles tolib/templateI hope that helps docsify users.