Use preview while reading and editing documentation. Use test before you rely on the result.
Open a preview
doxloop preview --openThe preview starts with live reload at http://127.0.0.1:4321 by default. Press <kbd>Ctrl</kbd>+<kbd>C</kbd> to stop it.
If the default port is occupied, choose another one:
doxloop preview --port 4400 --openYou can also bind to another host:
doxloop preview --host 0.0.0.0 --port 4321Check the result
doxloop testDoxloop checks documentation structure, navigation, local links, page metadata, code fences, and conventions for the selected output format. It prints each issue followed by a summary:
22 pages, 0 errors, 0 warningsdoxloop test exits with status 1 when an error remains. Warnings do not change the exit status. Fix every error before treating the documentation as ready.Use JSON when another tool consumes the result:
doxloop test --format jsonSee project details
doxloop statusThe current status output includes the title, project location, generator, page count, sources, design references, screenshot configuration, and current error and warning totals. It exits with status 1 when validation errors remain.
Use --format json for automation:
doxloop status --format jsondoxloop test performs fast project and content checks. For an external generator, its native strict build remains the final parser. Treat either failure as blocking.