Skip to content

Commit 3c1659f

Browse files
committed
Further rework the mike serve documentation
Now, we mention that `mkdocs serve` first, since it's arguably more useful.
1 parent d19e6f6 commit 3c1659f

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,12 @@ built-in MkDocs fields `remote_branch` and `remote_name`.)
151151

152152
### Viewing Your Docs
153153

154-
To test all the versions of your documentation as you'd see on your production
155-
server, you can serve them locally via:
154+
When editing your documentation, you can usually just use the ordinary [`mkdocs
155+
serve`][mkdocs-serve]. This serves the current version of your documentation
156+
without forcing you to create a Git commit first via `mike deploy`.
157+
158+
If you want to test all the versions of your documentation as you'd see on your
159+
production server, you can serve them locally via:
156160

157161
```sh
158162
mike serve
@@ -161,10 +165,6 @@ mike serve
161165
By default, this serves the docs on `http://localhost:8000`, but you can
162166
change this with `-a`/`--dev-addr`.
163167

164-
When editing your documentation, it's usually best to use `mkdocs serve`
165-
instead. This serves the current version of your documentation without forcing
166-
you to create a Git commit first via `mike deploy`.
167-
168168
> [!CAUTION]
169169
> `mike serve` and `mkdocs serve` should be used *for testing only*. To host
170170
> your docs for real, use a real web server.
@@ -401,4 +401,5 @@ This project is licensed under the [BSD 3-clause license](LICENSE).
401401
[shtab]: https://github.com/iterative/shtab
402402
[shtab-setup]: https://github.com/iterative/shtab#cli-usage
403403
[jinja]: https://jinja.palletsprojects.com/
404+
[mkdocs-serve]: https://www.mkdocs.org/user-guide/cli/#mkdocs-serve
404405
[gh-action-commit]: https://github.com/actions/checkout#push-a-commit-using-the-built-in-token

0 commit comments

Comments
 (0)