howard/lit-prog-book
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
A short book on literate programming in Emacs using Org Mode
4 commits 1 branch 0 tags 109 KiB
Find a file
Howard Abrams 5de9135575 Bug fix in the rendering code along with minor formatting 
Keep in mind that Hyperlinks, while good looking in Org, HTML and
other formats, are displayed inline in Info files, so we may want to
consider ways to have them look good in both.
2024-08-03 10:16:07 -07:00
.gitignore Initial attempt at a background for the book 2024-08-03 10:01:42 -07:00
LICENSE Initial commit 2024-08-03 15:32:23 +00:00
lp-in-org.org Bug fix in the rendering code along with minor formatting 2024-08-03 10:16:07 -07:00
README.org Bug fix in the rendering code along with minor formatting 2024-08-03 10:16:07 -07:00

README.org

Literate Programming in Org

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 the book in Info, execute the following:

  (progn
    (ignore-errors
      (kill-buffer "lp-in-org.info"))
    (find-file "lp-in-org.org")
    (find-file (org-texinfo-export-to-info))
    (Info-mode)
    (Info-top-node))