Skip to content

Search documentation

Type to search the documentation.

Doqs documentation

Doqs documentation

Install Doqs, connect it to an Analog application, write Markdown and ship searchable static documentation.

Start hereGetting started

Add Markdown documentation to an existing Angular and Analog application in a few minutes.

Read guide →
Start hereInstallation

Packages, peer dependencies and the supported environment for @doqs/analog.

Read guide →
Start hereThe doq CLI

doq init scaffolds the documentation files; doq doctor diagnoses the integration.

Read guide →
Start hereAnalog configuration

The four places a Doqs integration touches — paths, Vite, Angular providers and the stylesheet.

Read guide →
GuidesEmbedded documentation

Mount Doqs under /docs in a product site that keeps its own landing page and routes.

Read guide →
GuidesDocs-first applications

Make the whole application documentation by mounting Doqs at the root.

Read guide →
GuidesWriting Markdown

Frontmatter, groups, ordering, nested folders and slugs.

Read guide →
GuidesRich Markdown

Callouts, tabs, code groups, steps and titled code in plain Markdown.

Read guide →
GuidesInteractive components

Place your own standalone Angular components between Markdown paragraphs.

Read guide →
GuidesNavigation and search

Sidebar, table of contents, focus handling and optional static full-text search with Pagefind.

Read guide →
GuidesVersioned documentation

Keep the documentation of older releases readable at stable URLs.

Read guide →
GuidesAngular API reference

Generate reference pages from your library's public TypeScript API with doq-api.

Read guide →
GuidesStyling and host integration

Restyle Doqs with --host-docs-* tokens, layout options and host-owned slots, without a second theme system.

Read guide →
OperationsThe deterministic Vite plugin

Why doqDeterministicMarkdown() exists, how to add it and how to verify heading ids.

Read guide →
OperationsDeployment and CI

Build a static documentation site, index it for search and run checks in CI.

Read guide →
OperationsTroubleshooting

Common integration problems and the doq doctor findings that point to them.

Read guide →
ReferenceMigration and compatibility

What has been verified, what has not, and how upgrades behave.

Read guide →
ReferencePublic API

The exports, binaries and styles of @doqs/analog, with their intended stability.

Read guide →