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-19 14:35:55 +01:00
parent aa42998dbc
commit ff9c077f65
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.org
View file

@ -2,16 +2,22 @@
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).
* next * 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]] - test against [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content-org/all-posts.org][ox-hugo all-posts.org]]
- ATTR_HTML without printing child - i.e. above other, non-affiliated keyword
- more keywords: https://orgmode.org/manual/In_002dbuffer-settings.html - more keywords: https://orgmode.org/manual/In_002dbuffer-settings.html
- headlines - headlines
- unique ids - unique ids: see [[https://github.com/kaushalmodi/ox-hugo/blob/8472cf2d8667754c9da3728255634e8001a1da6d/ox-hugo.el#L1785-L1850][ox-hugo]] for auto generation
- CUSTOM_ID drawer property
- see [[https://github.com/kaushalmodi/ox-hugo/blob/8472cf2d8667754c9da3728255634e8001a1da6d/ox-hugo.el#L1785-L1850][ox-hugo]] for auto generation
- improve list parsing - improve list parsing
- handle list items with empty first line - handle list items with empty first line
- handle ordered list overrides [@10] - handle ordered list overrides [@10]
** links
https://orgmode.org/manual/External-links.html
https://orgmode.org/manual/Internal-links.html
radio target <<<MyTarget>>>
link target: <<go-org>>
link: [[go-org]]
link to headline
MyTarget <- this will automatically become a link - not sure i want this...
* differences to goorgeous * differences to goorgeous
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]]. 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. Please note that a visual comparison is not fair to goorgeous as the stylesheet is not adapted to it.