Skip to content
docsp
On this page

What docsp is

A static site generator for documentation portals that hold several projects, each with guides, an API reference, a changelog, versions and locales.

docsp turns Markdown pages and JSON configuration into a static documentation portal. One portal holds one or more projects. Each project gets its own tabs, sidebar, theme color, versions and languages, and the whole site shares one search index.

You write content in Markdown with a small set of directives (callouts, steps, code tabs, cards). You configure the site in site.json and each project in its project.json. docsp builds plain HTML into dist/, which any static host can serve.

What you get

Guides in Markdown

GitHub Flavored Markdown plus directives for callouts, steps, code tabs, cards, FAQ and glossary.

See the directives

API reference from OpenAPI

One page per operation, with parameters and request samples in curl, Go and TypeScript.

Generate API pages

Symbol index

Links from code to the symbols a compiler resolved, read from indexes your CI produces.

Link code to symbols

Built-in search

A Pagefind index written at build time. No search server.

How search works

Versions and languages

Old versions with a deprecation banner, translated pages with a fallback when a translation is missing.

Set up versions

Files for language models

Every page as Markdown, an llms.txt per project and a Copy for LLM button.

LLM outputs

What docsp does not do

  • It does not run a server. The output is static files; search runs in the browser.
  • It does not support a base path. Serve the site at the root of its domain, for example docs.example.org/, not example.org/docs/.
  • It does not let projects change the layout. A project can change its theme axes, banner, footer and logo; the components are the same for every project.
  • It does not run compilers. The symbol index reads files that your project's CI already produced.

How it is built

docsp is an Astro integration with a CLI around it. You do not need an astro.config file: the docsp command sets up Astro for you. Astro is a peer dependency, so you install it next to docsp.

↑ ↓ to move↵ to openSearching docsp