aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 8cf1c0bf18f3e537d72b57b21301b240c2e7806f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#+title: README

* Overview

This project uses [[https://orgmode.org/][org-mode]] to structure all documents, including the index page
and sub-pages such as blog posts.

* Configuration

If you want to replicate this project structure, you'll need to customize your
=.emacs= file appropriately, or load a custom =.el= file.

If you're within emacs while changing =.emacs=, you'll need to reload the
configuration with =M-x load-file= and hit enter to reload the current file
(=.emacs=).

See the [[./elisp/publish.el][publish.el]] file for this repository's 
configuration.

* Building

When ready to publish, open any of the =.org= files in the project and execute
=M-x org-publish-current-project=.

If you want to force emacs to re-publish all files, including files without
changes, execute =C-u M-x org-publish-current-project=.