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 — docs: add CLI reference page and link it from README by AllAboutDocs · Pull Request #67 · encode/mkdocs

Conversation

@AllAboutDocs

@AllAboutDocs AllAboutDocs commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

What

Adds a CLI reference page (docs/CLI.md) documenting the two available commands, mkdocs build and mkdocs 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

  • Documents --dir/--output on build and --dir on serve, all tested directly (not just taken from --help text).
  • Includes a note on the known mkdocs build console-output issue (Build output should list build outputs, not source inputs. #61), since it's the first thing most users will see.
  • Includes a note that serve does not currently support live-reload - confirmed by editing a file while the server was running and observing no auto-refresh.

Testing

Ran mkdocs serve locally and confirmed:

  • The CLI page renders correctly at /cli/ - headings, code blocks, and both notes all display as expected.
  • The new "CLI Reference" link on the homepage navigates correctly to the page.
  • The --dir and --output flags on build behave as documented (tested with a throwaway source/output folder).

Sorry, something went wrong.

Uh oh!

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

All reactions
@AllAboutDocs
docs: add CLI reference page and link it from README
859cc2d

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

No reviews

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.

1 participant

@AllAboutDocs
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.