History

Henrik Lissner 82abc8647a lang/org: remove recursive require (not necessary anymore?)		2018-01-06 04:15:19 -05:00
..
autoload	General minor refactor & comment revision	2018-01-06 03:03:02 -05:00
test	Conform unit test macros to naming scheme	2018-01-01 16:59:30 -05:00
+attach.el	lang/org: resolve +org-dir later	2017-12-24 15:13:38 -05:00
+babel.el	lang/org: refactor org init process	2017-12-09 14:42:46 -05:00
+capture.el	Fix invalid-file-location when capturing to todo template #296	2017-12-24 15:08:00 -05:00
+export.el	lang/org: silence redundant pandoc compilation warnings	2017-12-17 00:03:45 -05:00
+present.el	lang/org: refactor org init process	2017-12-09 14:42:46 -05:00
config.el	lang/org: remove recursive require (not necessary anymore?)	2018-01-06 04:15:19 -05:00
init.el	lang/org: add elpa org to load-path in init.el #327	2018-01-06 04:02:05 -05:00
packages.el	Add org elpa archive + update lang/org #327	2018-01-04 16:16:45 -05:00
README.org	lang/org: add baseline readme	2017-12-31 00:44:57 -05:00

README.org

:lang org

Table of Contents
Install
- MacOS
- Arch Linux
Configuration
Usage
Appendix

This module provides support for org-mode.

A custom attachment system that keeps files in a centralized location.
Drag-and-drop support for images (with inline preview) and media files (drops a file icon and a short link).
Executable code blocks with support for a variety of languages and tools, including REST requests, SQL, google translate, plantuml, and matlab.
An org-capture workflow that works from outside Emacs (through the bin/org-capture shell script).
Exported documents are saved to a centralized location.
A configuration for using org-mode for slide-show presentations, or exporting org files to reveal.js slideshows.
(TODO) A static site generator based in org-mode and Emacs.

org-mode is a beast, and Doom's most difficult module to maintain. And its most important. This module is highly opinionated and experimental; my foray into learning org is a neverending quest.

Install

Org has no hard dependencies, but there are some things you'll need to make use of Org's more esoteric features.

For inline LaTeX previews, you need latex and dvipng.
To run babel code blocks, you need whatever dependencies those languages need. It is recommended you enable the associated module in lang/ and ensure its dependencies are met.
The +crm module uses a sqlite database to manage your contacts, invoices, and projects; this needs sqlite installed.

MacOS

brew cask install mactex
brew install sqlite

Arch Linux

sudo pacman --needed --noconfirm -S texlive-core texlive-bin texlive-science sqlite

Configuration

(Coming soon)

Usage

(Coming soon)

Appendix

(Coming soon)