Generate docs for web #122
Merged
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
raulb
reviewed
Apr 15, 2021
There was a problem hiding this comment.
This is fantastic! Thank you @anaptfox !!!
Instead of making a list of suggestions or things I thought could be nice to have, I decided to open this other pull-request to this branch: #124
Let me know what you think and if you agree, just approve it and I'll make sure we get this shipped.
Thanks again!
raulb
force-pushed
the
fox-add-frontmatter
branch
from
470804a
to
dbfbd7d
Compare
raulb
approved these changes
Apr 15, 2021
raulb
force-pushed
the
fox-add-frontmatter
branch
from
dbfbd7d
to
8e617cf
Compare
6 tasks
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.
Description of change
The goal of this PR is to generate a version of the CLI docs that can be easily integrated to the web.
Type of change
Demo
Before this pull-request
Only
docs/cmdwere generated. This allows for proper docs in Github.After this pull-request
We now have both
docs/cmd/mdanddocs/cmd/www.There are two to not break docs in GitHub, and compile web-specific docs. The differences between the two:
-vs_(typical for URLs)/cli/commandURL (will be how it's represented in the web docs)