Skip to content
Doqs documentation/Getting started

Search documentation

Type to search the documentation.

Start here

Getting started

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

Doqs adds a documentation region to an Angular application that already uses Analog. Your header, footer, router, theme and components stay yours; Doqs supplies the Markdown routes, sidebar, table of contents and optional static search.

Note

Doqs does not create an Angular project. Start from an Analog application (npm create analog@latest), then follow the steps below.

Install the packages

Pick your package manager; the command is the same one the installation page lists.

pnpm add @doqs/analog @analogjs/content @analogjs/router prismjs

Showing the pnpm command.

Quick path

  1. Install the packages above in your Analog application.

  2. Scaffold the documentation files with the CLI that ships in the package. Nothing is overwritten; add --dry-run first to preview.

    pnpm exec doq init --dry-run
pnpm exec doq init

  3. Connect what the CLI printed. doq init creates src/doq.paths.ts and two Markdown pages, then lists the remaining edits to vite.config.ts, your Angular providers and your global stylesheet as exact snippets. See Analog configuration.

  4. Check the result and build.

    pnpm exec doq doctor
pnpm build

doq init reports Scaffold complete when the files exist and Integration complete only when it can see every required connection in your project. They are different things: generated files do not render until the providers, prerender routes and stylesheet are connected.

What you get

  • Routes for every Markdown file below src/content/docs, mounted at /docs (embedded) or at / (docs-first).
  • A sidebar grouped by frontmatter, a table of contents, previous and next links and a mobile drawer.
  • Static prerendering through Analog, so every page ships as HTML and hydrates.
  • Optional Pagefind search, versioned documentation, generated API reference pages and live Angular components inside Markdown. None of them is needed to display Markdown.

Next steps