OrgWiki/go-org-orgwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
go-org-orgwiki/README.org
Niklas Fasching d921a68a55 Add support for Table of Contents
2018-12-26 16:10:23 +01:00

3.1 KiB
Raw Blame History

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

  • more keywords: https://orgmode.org/manual/In_002dbuffer-settings.html

  • table of contents

    • see hugo ExtractTOC
    • loop the headlines and print an hX for each headline, ul for children

  • rethink frontmatter

    • use toml/yaml/json frontmatter from hugo (see hugo #5436):

      • complex values are a requirement of hugo, not Org mode
      • by giving up on the ability to mix front matter in org keyword (#+) and other formats we save a lot of complexity (that has little benefit)
      • Maybe allow for []string via KEYWORD[]: Tag Foo Bar - can be done in hugo

      -> the other problem is that org mode normally allows markup in the title - but we would have to render - and to what format

headlines

  • auto-generate unique ids: see ox-hugo

    • what about name conflicts?

links

https://orgmode.org/manual/External-links.html https://orgmode.org/manual/Internal-links.html radio target <<<MyTarget>>> link target: <<go-org>> link: /OrgWiki/go-org-orgwiki/src/commit/d036ddea4da35806b3f2032e33dac66b66ba77b9/go-org link to headline MyTarget <- this will automatically become a link - not sure i want this…

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.

  • not changing links to .org files into links to .html files

  • 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