Build your first portable page
Fictional sample. Every metric, status, organization, and decision on this page exists only to demonstrate the report engine; replace it with verified project evidence before use.
By the end of this tutorial you will have one offline HTML file built from Markdown—without authoring JSX, CSS, browser JavaScript, or a deployment configuration.
Start with one outcome
First-use path
- Run
agentic-report init ./my-page --starter tutorial. - Open
./my-page/report.mdand replace the sample title. - Run
agentic-report build ./my-page --output ./my-page.html. - Open
./my-page.htmldirectly in a browser.
Choose an output
Output formats
The default embeds the package runtime and local assets into one transportable HTML file.
agentic-report build ./my-page --output ./my-page.htmlThe directory format writes an HTML entry plus content-addressed assets for larger projects.
agentic-report build ./my-page --format directory --output ./my-page-distAdd semantic content
Call out a fact
Use a callout when the reader must not miss a constraint or result.
Record a decision
Use a decision block for the selected path and its consequence.
Show a sequence
Use steps or a timeline when order changes the meaning.
Show the smallest source example
title: Review summary
layout: document
theme: systemPractice and extend
Completed tutorial checks
Increment the counter after you initialize, edit, build, and open your own artifact.
Need focused diagnostics?
Run agentic-report validate ./my-page for source errors without writing output, or
agentic-report inspect ./my-page --json when an agent needs the observed feature inventory.
Keep the authoring boundary declarative
When a requirement fits a package primitive, express it as Markdown data. Do not rebuild the reader as a custom frontend.