Repository navigation
docs: add CLI reference page and link it from README - #67
Open
AllAboutDocs wants to merge 1 commit into
Open
AllAboutDocs wants to merge 1 commit into
AllAboutDocs wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
What
Adds a CLI reference page (docs/CLI.md) documenting the two available commands,
mkdocs buildandmkdocs serve, including their options. Also adds a link to this new page from the "Getting started" section of the homepage (docs/README.md), since it's the section that already introduces both commands by name.Why
Following up on the CLI documentation topic flagged after #60 - there's currently no reference page for the command-line tool itself, just a couple of commands mentioned in passing.
Notes
--dir/--outputonbuildand--dironserve, all tested directly (not just taken from--helptext).mkdocs buildconsole-output issue (Build output should list build outputs, not source inputs. #61), since it's the first thing most users will see.servedoes not currently support live-reload - confirmed by editing a file while the server was running and observing no auto-refresh.Testing
Ran
mkdocs servelocally and confirmed:/cli/- headings, code blocks, and both notes all display as expected.--dirand--outputflags onbuildbehave as documented (tested with a throwaway source/output folder).