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 2019-01-05 13:02:21 +01:00
parent 3e14771ebf
commit edd22b5014
1 changed files with 13 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.org
View file

@ -2,26 +2,19 @@
A basic Org mode parser in go. 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). Take a look at [[https://niklasfasching.github.io/go-org/][github pages]] for some examples and an online org -> html demo (requires wasm support).
[[https://raw.githubusercontent.com/niklasfasching/go-org/master/etc/example.png]] [[https://raw.githubusercontent.com/niklasfasching/go-org/master/etc/example.png]]
* todos * not yet implemented
** more links? ** deadlines and scheduling
https://orgmode.org/manual/External-links.html see https://orgmode.org/manual/Deadlines-and-scheduling.html
https://orgmode.org/manual/Internal-links.html ** latex fragments
radio target <<<MyTarget>>> see https://orgmode.org/manual/LaTeX-fragments.html
link target: <<go-org>> + mathjax for html_writer ?
link: [[go-org]] ** more types of links
link to headline see https://orgmode.org/manual/External-links.html & https://orgmode.org/manual/Internal-links.html
MyTarget <- this will automatically become a link - not sure i want this... - radio target <<<MyTarget>>>
* differences to goorgeous - link target: <<go-org>>
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]]. - link: [[go-org]]
Please note that a visual comparison is not fair to goorgeous as the stylesheet is not adapted to it. - link to headline
Nonetheless, the html output can be compared by taking a look in the developer console where relevant. - MyTarget <- this will automatically become a link - not sure i want this...
- different html output - existing css will have to be adapted
- 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)
- 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 * resources
- test files - test files
- [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content-org/all-posts.org][ox-hugo all-posts.org]] - [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content-org/all-posts.org][ox-hugo all-posts.org]]