This commit is contained in:
12
README.md
12
README.md
@@ -3,3 +3,15 @@
|
||||
This repository contains code for the website https://zainezq.com, which serves as a central familial hub for me.
|
||||
|
||||
The site is written using Emacs and Org-mode, and exported using the `org-publish` functionality. See the `build-site.el` script for details on how the site is built and published.
|
||||
|
||||
## Local authoring UI
|
||||
|
||||
Run `make author` and open `http://127.0.0.1:8765` to create or edit blog and post Org files from a browser.
|
||||
|
||||
The editor writes normal `.org` pages with the metadata used by the publishing pipeline:
|
||||
|
||||
- blogs are created under `blogs/YYYY/MM-month/slug.org`
|
||||
- posts are created under `posts/slug.org`, or `posts/section/slug.org` when a section is provided
|
||||
- saving a page starts `emacs -Q --script build-site.el` and then regenerates the search index
|
||||
|
||||
While that build is running, the UI disables editing and the API rejects further saves. The status panel unlocks the editor when publishing finishes.
|
||||
|
||||
Reference in New Issue
Block a user