Repository navigation
docs: comline doc --format html - #113
Merged
Merged
Conversation
The CLI reference, the comline doc and comline.toml references and the documenting guide cover the official HTML renderer: --format html and [doc] format = "html". schemas/comline-toml/0.x.json is refreshed, and the guide notes that the std pages are rendered with Markdown, as pages of this site.
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
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.
Documents the official HTML renderer (ComlineProject/generation#98, wired into the CLI by the cli PR):
reference/tools/doc.md:--format markdown|html|jsonand the HTML site's files (index.html,<module>.html,changelog.html,style.css,search.js), search, theme, and why it works offline and fromfile://.reference/cli.md: thecomline docrow.reference/congregation/comline-toml.md:format = "html".guide/documenting.md: "Or as a site of its own", and a note that the std pages are rendered with Markdown as pages of this site.schemas/comline-toml/0.x.json: refreshed from generation#98.The
cliandschemadrift checks compare against cli's and generation's default branches, so they fail until those PRs merge. Merge order: generation#98, then comline-rust#87 and comline-typescript#103, then the cli PR, then this one. Rerun the drift checks after that.Checks run locally:
zensical build --strict(no issues).