feat(gh-page): zero effort gh-page from readme with docsify #298
Conversation
This file contains 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
casaper
force-pushed
the
generate-gh-page-from-readme-doc
branch
2 times, most recently
from
de05616
to
00da7ab
Compare
|
With a docsify plugin I could now also use the original README.md instead of copying the original into the docs folder. So This way it'd really be zero effort. |
feat(gh-page): zero effort gh-page not requiring copy of README.md into docs directory fix: gh-page title fix: remove search because it does not work with remote markdown
casaper
force-pushed
the
generate-gh-page-from-readme-doc
branch
from
c80fd87
to
3e6221e
Compare
|
@casaper This is a great idea! the generated docs look great. |
cht8687
approved these changes
Feb 4, 2021
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.
Hi there
Actually I never used your eslint plugin.
Instead, I came looking up things in your repos readme allot, since that rendered as a great quick documentation for me.
The only flaw so far was that the readme isn't all that great to navigate.
I reckon with Docsify the exact same Readme can be rendered into a nicer to use webpage with next to no effort at all for you guys
It doesn't even require a build.
All you'd need to change would be enabling github pages for the docs directory of your project and https://you-dont-need.github.io/You-Dont-Need-Lodash-Underscore would be ready.
See: https://casaper.github.io/You-Dont-Need-Lodash-Underscore/#/