✨ Publier v1 is live — a polished docs platform built for the open web.
Skip to content

Guides

Step-by-step guides for advanced Publier features — content features, authoring workflows, and extensibility.

Browse guides on authoring rich technical docs with Publier — diagrams, math, OpenAPI, snippets, remote content, versioning, and custom plugins. Pick the feature you need; each guide is self-contained and runnable.

These guides assume you’ve already completed the quickstart. For the big picture of how Publier works, see the introduction.

Where to start

New to Publier?Start with the high-level overview — what Publier is and why it exists.
Adding a component?Browse the full catalog of 38 content and UI components.
Deploying?Ship to Vercel, Cloudflare, or your own host.
OpenAPI?Generate interactive API docs from your OpenAPI or AsyncAPI spec.

Content features

Enrich your pages with structured, interactive content. No build-time config needed — Publier auto-detects the peer dependencies and turns the feature on when present.

DiagramsMermaid flowcharts, sequence diagrams, class diagrams, and state machines in fenced code blocks.
Math equationsInline and display math with KaTeX — write LaTeX, render everywhere.
SnippetsReusable MDX fragments with {{propName}} placeholders — DRY for repeated content.
OpenAPI referenceGenerate interactive API docs from OpenAPI 3.x or AsyncAPI specs — request builder included.

Authoring workflows

Scale your docs site across versions, contributors, and sources.

VersioningServe multiple versions of your docs side by side with a version switcher.
Remote contentPull documentation from GitHub repos or HTTP endpoints at build time.
Graph viewInteractive force-directed graph of page relationships for content audits.

Extensibility

Go beyond the defaults when your content needs custom transforms or components.

PluginsExtend the MDX pipeline with custom remark/rehype plugins and auto-imported components.

What’s next