Guides
Step-by-step guides for advanced Publier features — content features, authoring workflows, and extensibility.
Browse guides for moving documentation, maintaining a site, and authoring rich technical content with Publier. Start with the workflow you need.
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 content and UI component references.
Deploying?Ship to Vercel, Cloudflare, or your own host.
OpenAPI?Generate reference pages from OpenAPI 3.x and add a playground explicitly.
Content features
Enrich pages with structured content. Follow each guide for its required dependencies, configuration, and generation steps.
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 OpenAPI 3.x reference pages and configure an optional request builder.
Authoring workflows
Scale your docs site across versions, contributors, and sources.
Migrate existing docsMove content and assets, preserve destinations, and qualify your host.
Migrate from MintlifyTranslate navigation, frontmatter, and MDX components.
Upgrades and rollbacksUpdate CLI and packages separately and restore a qualified release.
Maintain content and searchReview changes, preserve links, and check the built search index.
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
- Need a new component in a guide? Browse the component catalog.
- Configuring the scaffold or theme? See the CLI reference.
- Shipping a production build? Follow deployment.