Starts the Docusaurus development server for the docs site on port 3000, after freeing the port and linking the committed javadocs.
--clean.build-docs.py; it will not run the Docusaurus build or npm ci while this server is running.python3 scripts/start-docusaurus.py python3 scripts/start-docusaurus.py --clean
Then open http://localhost:3000.
| Option | Argument | Default | Meaning |
|---|---|---|---|
--clean | none | off | Remove .docusaurus/, build/ and node_modules/.cache before starting. |
package.json in the docs checkout; runs npm install if node_modules does not exist..dev-server-running is present, assumes another instance is running, prints a warning and exits 0.lsof -ti:3000, then kill -9), and waits two seconds. On Windows it uses netstat and taskkill.--clean, removes the cache directories.static/site/apidocs at the committed static/javadocs/<version> with a relative symlink (the version is the newest entry of static/javadocs/releases.json that has a directory, or the only versioned directory). Missing javadocs only produce a warning..dev-server-running lock file, runs npm start, and removes the lock file when the server stops.Progress lines on the console, then the Docusaurus server output until it stops.
| Code | Meaning |
|---|---|
| 0 | Server stopped with Ctrl-C, or another instance was already running. |
| 1 | package.json is missing, npm install failed, or npm start failed. |
.dev-server-running is how build-docs.py knows to skip npm ci and the production build. A crash that skips the cleanup leaves a stale lock; delete the file if the script refuses to start./site/ pages (Maven site) exist only after create-mvn-site.py or a full build; only the javadocs link is set up here.build-docs.py, create-mvn-site.pypages/developer-info/04.03.05.ScriptStartDocusaurus.md)