{"id":9635,"date":"2021-04-18T13:24:04","date_gmt":"2021-04-18T17:24:04","guid":{"rendered":"https:\/\/irreal.org\/blog\/?p=9635"},"modified":"2021-04-18T13:24:04","modified_gmt":"2021-04-18T17:24:04","slug":"writing-technical-documents-with-org-mode","status":"publish","type":"post","link":"https:\/\/irreal.org\/blog\/?p=9635","title":{"rendered":"Writing Technical Documents with Org Mode"},"content":{"rendered":"<p>alpha2phi has a nice post on <a href=\"https:\/\/alpha2phi.medium.com\/writing-technical-documentation-with-emacs-276f13284e54\">writing documentation with Emacs and Org-mode<\/a>. The post is reminiscent of Mike Hamrick\u2019s video on <a href=\"https:\/\/irreal.org\/blog\/?p=8452\">keeping technical documents consistent<\/a> and uses some of the same techniques.<\/p>\n<p>Alpha2phi starts with importing Fabrice Niessen\u2019s excellent <a href=\"https:\/\/github.com\/fniessen\/org-html-themes\">ReadTheOrg<\/a> theme for exporting (to HTML) Org documents. Like Hamrick, he imports a separate file with useful utility functions, including an initialization function that is called from the document\u2019s header.<\/p>\n<p>Finally, he shows how you can call a function to interpolate a value or some text in the body of the document.<\/p>\n<p>This post is a nice complement to Hamrick\u2019s video. If you prefer to read the material rather than watch a video of it, take a look at this post. The material is very useful for anyone writing documentation.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>alpha2phi has a nice post on writing documentation with Emacs and Org-mode. The post is reminiscent of Mike Hamrick\u2019s video on keeping technical documents consistent and uses some of the same techniques. Alpha2phi starts with importing Fabrice Niessen\u2019s excellent ReadTheOrg &hellip; <a href=\"https:\/\/irreal.org\/blog\/?p=9635\">Continue reading <span class=\"meta-nav\">&rarr;<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[18,4],"class_list":["post-9635","post","type-post","status-publish","format-standard","hentry","category-general","tag-emacs","tag-org-mode"],"_links":{"self":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts\/9635","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=9635"}],"version-history":[{"count":1,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts\/9635\/revisions"}],"predecessor-version":[{"id":9636,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=\/wp\/v2\/posts\/9635\/revisions\/9636"}],"wp:attachment":[{"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=9635"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=9635"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/irreal.org\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=9635"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}