https://scripter.co/how-do-i-write-org-mode/ Prefer “Org mode” to “Org-mode” or “org-mode”. This is simply because it reflects an existing convention in The Emacs Manual which consistently documents mode names in this form - “Text mode”, “Outline mode”, “Mail mode”, etc. |
||
---|---|---|
etc | ||
org | ||
.gitignore | ||
.travis.yml | ||
main.go | ||
Makefile | ||
README.org |
- go-org https://travis-ci.org/niklasfasching/go-org.svg?branch=master
- next
- differences to goorgeous
- resources
go-org https://travis-ci.org/niklasfasching/go-org.svg?branch=master
A basic Org mode parser in go. Take a look at github pages for some examples and an online org -> html demo (requires wasm support).
next
-
test against ox-hugo all-posts.org
-
fix attr_html splitting - not whitespace, :x keywords, e.g.
-
- more keywords: https://orgmode.org/manual/In_002dbuffer-settings.html
-
headlines
- export priority as default
-
unique ids
- CUSTOM_ID drawer property
- see ox-hugo for auto generation
-
improve list parsing
- handle list items with empty first line
- handle checkboxes & statistic cookies
- handle ordered list overrides [@10]
TODO
list checkboxes & statistics [0/2]
https://orgmode.org/manual/Checkboxes.html
-
parse checkbox of list item
- convert to html radio button unchecked, indeterminate (visual only), checked
- parse statistic cookies of headlines & first line of list items
-convert to
[sub 1<sup>1</sup>⁄<sub>2</sub>] || [90%]
differences to goorgeous
To get a feeling take a look at goorgeous vs go-org html rendering of the examples comparison. Please note that a visual comparison is not fair to goorgeous as the stylesheet is not adapted to it. Nonetheless, the html output can be compared by taking a look in the developer console where relevant.
- no headline ids
-
not changing links to .org files into links to .html files
- do not plan to implement this, too many edge cases (e.g. mangling links to e.g. example.org.)
- org comments not rendered as html comments (same as ox-html.el)
- headline priority not exported to html (same as ox-html.el)
- goorgeous treats all `file:` links as images - go-org checks for an image file extension (same as ox-html.el)
-
no support for [@10] in ordered lists https://github.com/chaseadamsio/goorgeous/issues/18
- do not plan to implement this
resources
- https://orgmode.org/manual/
- https://orgmode.org/worg/dev/org-syntax.html
-
https://code.orgmode.org/bzg/org-mode/src/master/lisp/org.el
- https://code.orgmode.org/bzg/org-mode/src/master/lisp/org-element.el
- mostly those & ox-html.el, but yeah, all of https://code.orgmode.org/bzg/org-mode/src/master/lisp/
- existing Org mode implementations: org, org-ruby, goorgeous, pandoc