Technical documentation

Docs-as-code without the last mile: keep documentation as Markdown in your repository, reviewed in the same pull requests as the code, and let a GitHub Action publish it on merge. There is no static site generator config to maintain and no deploy pipeline to babysit.

The pipeline

name: Deploy docs

on:
  push:
    branches: [main]
    paths: [docs/**]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: sitepaste/integrations/actions/deploy@v1
        with:
          api-token: ${{ secrets.SITEPASTE_TOKEN }}
          content-dir: docs
          content-type: docs

That is the entire pipeline. The action validates every file locally. Bad slugs, oversized content, and duplicates all fail the workflow with an annotation pointing at the exact file. It then publishes the batch and triggers a deploy. Deploys build in seconds. It needs an API token, which is a Pro feature; see the full guide for details, including the prune option that deletes pages when their files are removed from the repo.

Structure from directories

Directories become sections, which become sidebar navigation:

docs/
  overview.md              → /docs/overview
  guides/
    getting-started.md     → /docs/guides/getting-started
    deployment.md          → /docs/guides/deployment
  api/
    authentication.md      → /docs/api/authentication

There is no config file and no sidebar definition. Directories are mapped as-is, one level deep. Front matter is optional; the slug comes from the filename when you skip it.

Reader-facing details

The theme settings give docs sites what readers expect: sidebar navigation (nested or flat), a table of contents, breadcrumbs, next/previous links, search, and syntax-highlighted code blocks in light and dark. There is also a per-page “Copy markdown” button, handy when your readers want to paste a doc into a chat or an AI tool.

Why teams pick it

It is one less system to own. There is no Docusaurus config, no MkDocs theme, and no Hugo config.toml. Sitepaste is the hosting, the build, and the deployment. Docs stay Markdown in your repo, your review process doesn’t change, and the published site updates itself when the code merges.