Documentation Guides

serve #

The serve command is used to preview documentation by serving it via HTTP at localhost:8002 by default:

$> romero serve

The serve command command watches the documentation’s src directory for changes, rebuilding the documentation and refreshing clients for each change. A websocket connection is used to trigger the client-side refresh. romero will try to only rebuild the changed-page if it can, and will rebuild the entire documentation if necessary: That includes re-creating deleted files still in mentioned in SUMMARY.md.

Note

The serve command is meant for testing a documentation’s rendered output, and is not intended to be a complete HTTP server for a website.

Specify an address to bind #

The serve command can take a IP:port couple as an argument to use as the HTTP server bind:

$> romero serve localhost:8003

--render #

Specify a render engine for this build. Defaults to html.

--theme #

Override the theme for the rendered website. See Themes for available options.

--no-check #

Skip all link checking after building. Use this flag to disable link checking entirely.

--no-check-external #

Skip checking external URLs for dead links. In serve mode, dead links (both internal and external) are logged as warnings but never stop the server. Use this flag to skip external URL checks entirely.