build #

The build command is used to render your documentation:

$> romero build

romero will try to parse the SUMMARY.md file to understand the structure of your documentation, and will try to render them in a directory. The rendered output will maintain the same directory structure as the source for convenience. Large documentations will therefore remain structured when rendered.

By default, romero will render your documentation in the book/ directory. This behavior can be changed by changing the build.build-dir configuration token.

--render #

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

--site-url #

For HTML render: Specify the a root-path for the generated website. Defaults to /

--edit-url-template #

For HTML render: Specify a template for rendering edition links for pages. Use {{ . }} for path, eg; http://github.com/user/repo/edit/{{ . }})

--theme #

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

--no-check #

Skip all link checking after building. By default, romero validates both internal and external links in the generated output. Use this flag to disable link checking entirely (useful for renderers like html-single where anchor IDs use a different scheme).

--no-check-external #

Skip checking external URLs for dead links. By default, romero checks both internal and external links after building. Internal dead links always fail the build; external dead links are reported as warnings. Use this flag to skip the external URL checks entirely (useful for offline builds or CI environments without internet access).