OrgWiki/go-org-orgwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Niklas Fasching 2018-12-20 16:39:05 +01:00
parent 854f8e181a
commit e8b90ab9d4
2 changed files with 8 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.org
View file

@ -2,11 +2,12 @@
A basic Org mode parser in go.
Take a look at [[https://niklasfasching.github.io/go-org/][github pages]] for some examples and an online org -> html demo (requires wasm support).
* next
- https://ox-hugo.scripter.co/doc/examples/
- test against [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content-org/all-posts.org][ox-hugo all-posts.org]]
- more keywords: https://orgmode.org/manual/In_002dbuffer-settings.html
- headlines
- unique ids: see [[https://github.com/kaushalmodi/ox-hugo/blob/8472cf2d8667754c9da3728255634e8001a1da6d/ox-hugo.el#L1785-L1850][ox-hugo]] for auto generation
- table of contents
- rethink frontmatter - expose buffer setting for defining which keywords should be parsed as arrays / ...
** headlines
- auto-generate unique ids: see [[https://github.com/kaushalmodi/ox-hugo/blob/8472cf2d8667754c9da3728255634e8001a1da6d/ox-hugo.el#L1785-L1850][ox-hugo]]
- what about name conflicts?
** links
https://orgmode.org/manual/External-links.html
https://orgmode.org/manual/Internal-links.html
@ -19,16 +20,16 @@ MyTarget <- this will automatically become a link - not sure i want this...
To get a feeling take a look at goorgeous vs go-org html rendering of the examples [[https://niklasfasching.github.io/go-org/go-org-vs-goorgeous][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. [[https://github.com/chaseadamsio/goorgeous/issues/56][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
- test files
- [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content-org/all-posts.org][ox-hugo all-posts.org]]
- https://ox-hugo.scripter.co/doc/examples/
- https://orgmode.org/manual/
- https://orgmode.org/worg/dev/org-syntax.html
- https://code.orgmode.org/bzg/org-mode/src/master/lisp/org.el