u/unixbhaskarin r/emacs • Recommends
Consistent Technical Documents Using Emacs and Org Mode
0:00 / 0:00
Consistent Technical Documents Using Emacs and Org Mode
spudlyo
1.5K subscribers • 1 video on Hallway
- Recommended by 6 people: 2 on Hacker News, 3 on Lobsters and 1 in engineering communities.
- A classic. People kept recommending it from 2019 to 2025.
- Linked in the descriptiongitlab spudlyo/orgdemogitlab spudlyo/dotfilesfniessen/org-html-themes
Intermediate. Assumes working knowledge.
73K views6 years ago6 recommendations
Tools and practiceVim, Emacs and editorsGit and version control
A demonstration of using Emacs Org mode and org-babel to write technical documents with dynamic, consistent code blocks.
Files used in the demo: gitlab.com/spudlyo/orgdemo My dotfiles: gitlab.com/spudlyo/dotfiles Read The Org: github.com/fniessen/org-html-themes Read The Docs: sphinx-rtd-theme.readthedocs.io/en/latest/installing.html Git from the Bits Up: youtube.com/watch?v=MYP56QJpDr4Why it's here
6 people recommend thisWhat people say. Recommended as an excellent demonstration of the power of Org mode's literate programming and org-babel for technical documentation.
rauon Lobsters • Recommends
Consistent technical documents using Emacs and Org Mode
Hail_Spacecakeon Lobsters • Recommends
Consistent Technical Documents Using Emacs and Org Mode
d0mineon Hacker News • Recommends
On “Text-Only Websites”
Org mode supports inline Latex that can be exported to html. Here's a nice demo on how to write tech docs using Emacs and Org mode link to this video
spudlyoon Hacker News • Recommends
On “From Vim to Emacs in fourteen days (2015)”
I made a video0 showing off the power of org-babel, which is the part of org that lets you embed dynamic code blocks in your document. In the video I write a little essay1 on how git stores data that has a lot of dynamic content that is managed by org. It's a bit like reproducible research or literate programming, but for me it's all about writing technical documents that are easy to keep consistent when things change. 0: link to this video 1: link
spudlyoon Hacker News • Recommends
On “The open calendar, task and note space is a mess”
Org mode does a lot of different things, but one use case I find interesting is to be able to mix prose and program output in a technical document in a way that keeps things consistent when things change. I made a video0 a year or so ago that explores Org's literate programming features that I think does a pretty good job of illustrating the power of Org. 0: link to this video
spudlyoon Hacker News • Recommends
On “Atuin Desktop: Runbooks That Run”
Thanks for the shout-out! I think org-babel is really well suited for this task, and can make some really great documentation. You can check out the video0 from the talk and a git repo1 with a more advanced demonstration. 0: link to this video 1: link
stigon Lobsters • Recommends
Consistent Technical Documents Using Emacs and Org Mode
u/StudentCoder4862in r/emacs • Mentions
Consistent Technical .docx Documents Using Emacs and Org Mode?
I recently viewed Mike Hamrick's excellent video Consistent Technical Documents Using Emacs and Org Mode and was wondering if someone had figured out how to do the same with .docx documents as the output format.
I work in an industry that is Microsoft Office centric. I need to generate a lot of documents in .docx format that all follow the same basic outline, but each contain a lot of custom text. The custom text will depend on the circumstances, but will generally follow one of a handful of tracks. I want to eventually build a text library where the correct "track" (i.e., blocks of text) could be selected at the outset, p…
rwnspaceon Hacker News • Mentions
On “Ask HN: Resources to grok Emacs and use it well?”
…Doom. Tinker with it a bit. Take notes of your learning in an org file. Tinker some more. Go back to plain emacs for a bit. Then try spacemacs. Go straight back to Doom because it's faster and you now understand enough about emacs to be scared of spacemacs' layers. Below are some links to help you along the way. link link link link link link to this video link…