docs.doomemacs.org

This repository houses the HTML build pipelines for Doom's documentation. It scrapes the documentation from the recent release branches of doomemacs/core, doomemacs/modules, and doomemacs/modules-contrib, and is published to docs.doomemacs.org.

Prerequisites

Compiling this project to HTML requires the following:

• Emacs >= 27.1
• Doom core >= 3.0.0
• dart-sass >= 1.89.2
• minify >= 2.23.1

This project contains a shell.nix that will initialize an environment for building this project (except for Emacs). If Doom Core's bin/doom script is present on your $PATH, that will be used instead deploying a project-local copy.

Publishing

Important

The doom publish command and the associated CI/CD that auto-publishes this repo to docs.doomemacs.org are a work-in-progress and are not yet available, so the instructions below will not work yet. This notice will be removed once that changes.

This repository is automatically built and published to docs.doomemacs.org. Here's how to build and preview the latest documentation manually:

git clone --depth 1 https://github.com/doomemacs/docs docs
cd docs
nix-shell
publish   # defined in shell.nix

python -m http.server 8000  # any http server will do
firefox 127.0.0.1:8000