Skip to content

Commit

Permalink
Add a note about using mkdocs serve
Browse files Browse the repository at this point in the history
  • Loading branch information
jimporter committed Jan 22, 2024
1 parent 01446f8 commit 3db2637
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@ By default, this serves the docs on `http://localhost:8000`, but you can
change this with `-a`/`--dev-addr`. Remember though, *this is for testing only*.
To host your docs for real, you should use a real web server.

> [!NOTE]
> When editing your documentation, it's usually best to use `mkdocs serve`
> instead. This renders the current version of your documentation without
> forcing you to create a Git commit first via `mike deploy`.
### Deleting Docs

Sometimes you need to delete an old version of your docs, either because you
Expand Down

0 comments on commit 3db2637

Please sign in to comment.