Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 1.24 KB

writing_documentation.org

File metadata and controls

26 lines (21 loc) · 1.24 KB

Writing Documentation

This documentation uses a format called Org. It’s native to Emacs but the subset of it that is used here is small enough and simple enoug that it can be written in any text editor. To familiarize yourself with Org, take a look at this Org Mode Syntax Cheat Sheet.

Editor Support

GNU Emacs

Org is native to Emacs, so if you have Emacs, you already have Org setup and ready.

Vim/NVim

Vim/NVim doesn’t have full support for all of Orgs features, but the subset used here is supported. You can get support by installing org.vim.

VSCode/VSCodium

VSCode/VSCodium doesn’t have full support for all of Orgs features, but the subset used here is supported. You can get support by installing vscode-org-mode.org-mode.