This is just a brain dump and the Background and Advantages section need to be proof-read. We should also expand on the general outline and table of contents, as the headers here are just a start.
28 lines
1 KiB
Org Mode
28 lines
1 KiB
Org Mode
#+title: Literate Programming in Org
|
|
#+date: 2024-08-03 August
|
|
#+tags: book literate-programming lp emacs org org-mode
|
|
|
|
# (progn (find-file (org-texinfo-export-to-info)) (Info-mode) (Info-top-node))
|
|
|
|
This is a book on /Literate Programming in Emacs/ using Org Mode.
|
|
|
|
The goal is to write the book as an org document, and then /export/ it as:
|
|
- Info, readable in Emacs
|
|
- PDF and Epub, readable on devices
|
|
- HTML to be viewable as a web page in EWW
|
|
- Org, downloadable and useful when this project is cloned
|
|
|
|
A question on /interactive-ness/. Since the goal is to teach LP through Emacs (and not just a general guide on LP), we want the text viewable in Emacs, so that code can be easily copy/pasted into their own notes, as well as allowing the user to enter ~C-x C-e~ on any s-expression.
|
|
|
|
To render and read [[file:lp-in-org.org][the book]] in Info, execute the following:
|
|
|
|
#+begin_src emacs-lisp
|
|
(progn
|
|
(find-file "lp-in-org.org")
|
|
(find-file (org-texinfo-export-to-info ))
|
|
(Info-mode)
|
|
(Info-top-node))
|
|
#+end_src
|
|
|
|
#+RESULTS:
|