GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Add options to generate docs with sidebar, navbar and coverpage by WesleyGoncalves · Pull Request #104 · docsifyjs/docsify-cli

Conversation

@WesleyGoncalves

@WesleyGoncalves WesleyGoncalves commented Apr 26, 2020

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
WesleyGoncalves and others added 9 commits April 26, 2020 19:08
@WesleyGoncalves
feat: add option to generate docs with sidebar
21045bb
Optionally include sidebar when creating new docs
@WesleyGoncalves
docs: add init sidebar option
ebfc5de
@WesleyGoncalves
feat: add option to generate docs with navbar
9845e88
Optionally include navbar when creating new docs
@WesleyGoncalves
docs: add init navbar option
fd0bdb9
@WesleyGoncalves
feat: add option to generate docs with coverpage
28220b3
Optionally include coverpage when creating new docs
@WesleyGoncalves
docs: add init coverpage option
691b690
@sy-records
Update
cbb24ac
@sy-records
revert
ac5e0bb
@sy-records
revert
5145153
@sy-records
sy-records requested review from anikethsaha and jamesgeorge007 October 30, 2020 09:25
sy-records
sy-records approved these changes Oct 30, 2020
View reviewed changes

@sy-records sy-records left a comment

Copy link
Copy Markdown
Member

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

WesleyGoncalves reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
jamesgeorge007
jamesgeorge007 reviewed Oct 31, 2020
View reviewed changes

@jamesgeorge007 jamesgeorge007 left a comment

Copy link
Copy Markdown
Member

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@sy-records

sy-records commented Nov 1, 2020

Copy link
Copy Markdown
Member

What template? _sidebar.md these?

WesleyGoncalves reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jamesgeorge007 jamesgeorge007 jamesgeorge007 left review comments
@sy-records sy-records sy-records approved these changes
@anikethsaha anikethsaha Awaiting requested review from anikethsaha

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@WesleyGoncalves @sy-records @jamesgeorge007
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.