Tech Writer's Guide

Docs-as-Code Tools

Static site generators, documentation frameworks, themes, linters, search and hosting used to build documentation from plain-text source in a Git repository.

77 tech writing resources / page 2 of 3

Rspress

Docs-as-Code Tools

A Rspack-powered static site generator for documentation, supporting MDX content and built-in full-text search.

rspress.dev

AsciiDoc

Docs-as-Code Tools

A plain-text authoring format designed for technical documentation, offering more structure than Markdown while remaining editable in any text editor.

asciidoc.org

Pandoc

Docs-as-Code Tools

A universal document converter that translates between dozens of markup and word-processing formats, widely used in documentation build pipelines.

pandoc.org

Eleventy

Docs-as-Code Tools

A JavaScript static site generator that works with many template languages and produces plain HTML output with no client-side framework required.

11ty.dev

Overleaf

Docs-as-Code Tools

A browser-based collaborative LaTeX editor with real-time editing, version history and template libraries for technical and scientific documents.

overleaf.com

textlint

Docs-as-Code Tools

A pluggable natural-language linter for Markdown and plain text, with a rule ecosystem covering grammar, terminology and formatting conventions.

textlint.github.io

Payload

Docs-as-Code Tools

An open-source TypeScript headless CMS and application framework built to run inside a Next.js project.

payloadcms.com

mdBook

Docs-as-Code Tools

A Rust command-line tool that turns a collection of Markdown files into an online book, used for much of the Rust project's own documentation.

rust-lang.github.io

Sanity

Docs-as-Code Tools

A headless content platform with a customisable editing environment and APIs, used to manage structured documentation and product content.

sanity.io

Docsy

Docs-as-Code Tools

A Hugo theme built for technical documentation sites, providing navigation, versioning support and a documentation-oriented page layout.

docsy.dev

Front Matter CMS

Docs-as-Code Tools

A headless CMS that runs inside Visual Studio Code, managing Markdown content for static site generators such as Hugo, Jekyll and Astro.

frontmatter.codes

Lunr.js

Docs-as-Code Tools

A small client-side search library that builds a search index in the browser, used by static documentation sites with no search backend.

lunrjs.com

Meilisearch

Docs-as-Code Tools

An open-source search engine written in Rust that offers fast typo-tolerant search and is often used to power documentation site search.

meilisearch.com

Docsify

Docs-as-Code Tools

A documentation site generator that skips the build step entirely, loading and rendering Markdown files in the browser at request time.

docsify.js.org

alex

Docs-as-Code Tools

A linter that flags insensitive or inconsiderate wording in prose, intended to be run over documentation alongside other style checks.

alexjs.com

Algolia DocSearch

Docs-as-Code Tools

Algolia's free search service for open-source documentation sites, which crawls a docs site and provides a hosted search index and UI.

docsearch.algolia.com

Shiki

Docs-as-Code Tools

A syntax highlighter that uses TextMate grammars and VS Code themes to render code blocks in documentation exactly as an editor would.

shiki.style

VuePress

Docs-as-Code Tools

A Vue-powered static site generator created for technical documentation, where each Markdown page becomes a Vue single-file component.

vuepress.vuejs.org

HugoBlox

Docs-as-Code Tools

An open-source structured-content framework built on Hugo, providing reusable blocks for documentation, portfolio and research sites.

hugoblox.com

Pygments

Docs-as-Code Tools

A Python syntax highlighting library supporting a very large number of languages, used by Sphinx and other documentation toolchains.

pygments.org

Jekyll

Docs-as-Code Tools

A Ruby static site generator that turns Markdown and Liquid templates into a static site. It is the generator behind GitHub Pages.

jekyllrb.com

DocBook

Docs-as-Code Tools

A long-established XML schema for technical documentation, with stylesheets that publish the same source to HTML, PDF and print.

docbook.org

Astro

Docs-as-Code Tools

A web framework for content-driven sites that ships zero JavaScript by default and underpins the Starlight documentation theme.

astro.build

docs.page

Docs-as-Code Tools

A service that publishes a documentation site directly from a GitHub repository of Markdown files with no build or deploy step.

docs.page

Retype

Docs-as-Code Tools

A documentation site generator that builds a searchable static site from a folder of Markdown files with minimal configuration.

retype.com

Zensical

Docs-as-Code Tools

A documentation site generator from the team behind Material for MkDocs, aimed at fast builds for large documentation projects.

zensical.org

Keystatic

Docs-as-Code Tools

An open-source content management tool from Thinkmill that edits Markdown and structured content stored in a Git repository.

keystatic.com

Docutils

Docs-as-Code Tools

The Python text processing system that defines and parses reStructuredText, forming the foundation that Sphinx is built on.

docutils.sourceforge.io

Gatsby

Docs-as-Code Tools

A React-based site framework that pulls content from Markdown, CMSs and APIs through a GraphQL layer to build static sites.

gatsbyjs.com

Prettier

Docs-as-Code Tools

An opinionated code formatter that also formats Markdown and MDX, often used to keep documentation source files consistent.

prettier.io

Markdown Guide

Docs-as-Code Tools

A free open-source reference that documents Markdown syntax, including the differences between common Markdown flavours.

markdownguide.org

markdownlint

Docs-as-Code Tools

A Node.js style checker and lint tool for Markdown and CommonMark files, commonly wired into documentation CI pipelines.

github.com

Hexo

Docs-as-Code Tools

A fast Node.js static site generator that renders Markdown into static pages, used for blogs and project documentation.

hexo.io

Hugo

Docs-as-Code Tools

A fast open-source static site generator written in Go, commonly used for documentation sites via themes such as Docsy.

gohugo.io

MDX

Docs-as-Code Tools

A format that lets writers embed JSX components directly in Markdown, used by many JavaScript documentation frameworks.

mdxjs.com

write-good

Docs-as-Code Tools

A simple English prose linter that flags common writing problems such as passive voice, weasel words and wordy phrases.

github.com