From ba1a20ac3ba3452cead3cc51de7140d29236f513 Mon Sep 17 00:00:00 2001 From: not manx Date: Wed, 22 Jul 2020 00:24:52 +0000 Subject: [PATCH] Update README --- README.org | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 50 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index f504cce..1f4365c 100644 --- a/README.org +++ b/README.org @@ -4,8 +4,56 @@ extensions to [[https://github.com/balddotcat/ox-slimhtml][ox-slimhtml]]. Used to publish words I write. ** Installation -You want to clone the repo, cd to it then do ~M-x package-install-file -ox-plumhtml.el~ +You want to clone the repo, cd to it then do ~M-x +package-install-file~ on ~ox-plumhtml.el~ +** Header IDs +In org-mode you can do something like +#+begin_example +,#+plumhtml_header_ids: +,* Header 1 +..... +some content... +..... +,* Header 2 +[[Header 1][Link to header 1]] +#+end_example +And the link will jump back to =Header 1= when you click it. + +This is implemented in ox-plumhtml conditionally by setting the +variable ~ox-plumhtml-export-header-ids~, or putting +~#+plumhtml_header_ids: t~ in your org file. + +Exported contents look like this when set to nil: +#+begin_src html + + + + +

Header 1

..... +some content... +..... +

+

Header 2

Link to header 1 +

+ + +#+end_src +And this when non-nil: +#+begin_src html + + + + +

Header 1

..... +some content... +..... +

+

Header 2

Link to header 1 +

+ + +#+end_src +It adds some noise to the outputted file but it's worth it IMO. ** Functions *** ~ox-plumhtml-export-as-html~ Makes a temporary buffer with the exported HTML.