mkdocs serve
Run the builtin development server
Options
Name | Description |
---|---|
-h, --help | help for serve |
-q, --quiet | Silence warnings |
-v, --verbose | Enable verbose output |
-f, --config-file <arg> | Provide a specific MkDocs config |
-s, --strict | Enable strict mode. This will cause MkDocs to abort the build on any warnings |
-t, --theme <theme> | The theme to use when building your documentation |
--use-directory-urls | Use directory URLs when building pages (the default) |
--no-directory-urls | Don't use directory URLs when building pages |
-a, --dev-addr <IP:PORT> | IP address and port to serve documentation locally (default: localhost:8000) |
--live-reload | Enable the live reloading in the development server (this is the default) |
--no-reload | Disable the live reloading in the development server |
--dirtyreload | Enable the live reloading in the development server, but only re-build files that have changed |
--watch-theme | Include the theme in list of files to watch for live reloading. Ignored when live reload is not used |
-w, --watch <arg> | A directory or file to watch for live reloading. Can be supplied multiple times |