openwiki

Help · Publishing

Publish your first OpenWiki document

OpenWiki publishes a deterministic .mdw package, not a loose Markdown or HTML file. The Agent builds and checks the package locally, then the CLI returns durable reading and management links.

Updated August 3, 2026Product documentation
OpenWiki Hosted publication workflow showing a rendered report and its stable document identity
Real OpenWiki Hosted output: a typed document is rendered as a reader-facing page after local validation.

1. Verify the CLI and Agent skill

Run the readiness checks before building a document. Setup is complete only when the CLI exists and the installed skill passes its doctor check.

command -v ow
ow agent doctor --target auto

2. Build a typed document

Create a draft workspace, add the required sections and typed presentation nodes, then run the local validation sequence. Do not hand-edit the generated package.

ow a2ui draft init ./artifact --title "Launch plan" --description "Decision-ready launch plan" --language en
ow a2ui draft check ./artifact
ow a2ui draft build ./artifact
ow a2ui digest ./artifact/document.mdw

3. Publish the package

Publish only after check, build, and digest succeed. The Hosted service validates the binary package again before accepting it.

ow publish ./artifact/document.mdw --no-open
Product boundary

Raw Markdown, raw HTML, directories, stdin, Bundle JSON, and JSON-LD are not Hosted publish inputs.

4. Keep the returned identities

  1. Share the view URL with readers.
  2. Keep the document ID for later updates and recovery.
  3. Treat review or edit capability links as secrets; do not use them as public reading links.
  4. Open the published page and verify the real rendered result before handing it off.

FAQ

Frequently asked questions

Can OpenWiki publish a Markdown file directly?

No. OpenWiki Hosted accepts a validated .mdw package built with ow a2ui draft; raw Markdown is not a Hosted publish input.

Do I need an account to build the document locally?

No. Draft construction, checks, builds, and digests run locally. An account and Hosted credential are required only when you publish.

Use the real workflow

Publish what your agent creates.

Give every report, document, or plan its own reader-ready page. Comments, review decisions, and formal revisions can flow back from there.

Choose HostedSign in