wiki.doomemacs.org

This repository houses the contents of wiki.doomemacs.org, the Doom Emacs community wiki.

This wiki is intended to compliment docs.doomemacs.org, and is a better fit for more niche, advanced, or holistic subjects. Anyone may contribute to it, though, please consult our Do Not PR list before opening a pull request.

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 wiki.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 wiki.doomemacs.org. Here's how to build and preview it manually:

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

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

publish will only update changed files. Run clean delete all build artifacts to make the next publish rebuild all files from scratch.