Doqs documentation
Doqs documentation
Install Doqs, connect it to an Analog application, write Markdown and ship searchable static documentation.
Add Markdown documentation to an existing Angular and Analog application in a few minutes.
Read guide →Start hereInstallationPackages, peer dependencies and the supported environment for @doqs/analog.
Read guide →Start hereThe doq CLIdoq init scaffolds the documentation files; doq doctor diagnoses the integration.
Read guide →Start hereAnalog configurationThe four places a Doqs integration touches — paths, Vite, Angular providers and the stylesheet.
Read guide →GuidesEmbedded documentationMount Doqs under /docs in a product site that keeps its own landing page and routes.
Read guide →GuidesDocs-first applicationsMake the whole application documentation by mounting Doqs at the root.
Read guide →GuidesWriting MarkdownFrontmatter, groups, ordering, nested folders and slugs.
Read guide →GuidesRich MarkdownCallouts, tabs, code groups, steps and titled code in plain Markdown.
Read guide →GuidesInteractive componentsPlace your own standalone Angular components between Markdown paragraphs.
Read guide →GuidesNavigation and searchSidebar, table of contents, focus handling and optional static full-text search with Pagefind.
Read guide →GuidesVersioned documentationKeep the documentation of older releases readable at stable URLs.
Read guide →GuidesAngular API referenceGenerate reference pages from your library's public TypeScript API with doq-api.
Read guide →GuidesStyling and host integrationRestyle Doqs with --host-docs-* tokens, layout options and host-owned slots, without a second theme system.
Read guide →OperationsThe deterministic Vite pluginWhy doqDeterministicMarkdown() exists, how to add it and how to verify heading ids.
Read guide →OperationsDeployment and CIBuild a static documentation site, index it for search and run checks in CI.
Read guide →OperationsTroubleshootingCommon integration problems and the doq doctor findings that point to them.
Read guide →ReferenceMigration and compatibilityWhat has been verified, what has not, and how upgrades behave.
Read guide →ReferencePublic APIThe exports, binaries and styles of @doqs/analog, with their intended stability.
Read guide →