OrgWiki/go-org-orgwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
patched https://github.com/niklasfasching/go-org for orgwiki
204 commits 1 branch 0 tags 626 KiB
Find a file
Niklas Fasching 7c239a7aeb html: Add support for #+TOC keyword 
org mode allows rendering the toc anywhere in the html document using the `TOC`
keyword [1]. There's more options but `#+TOC: headlines $n` should be enough
for starters. Note that org mode still requires setting `#+OPTIONS: toc:nil` to
disable the default toc

[1] https://orgmode.org/manual/Table-of-Contents.html
2021-03-28 17:12:25 +02:00
.github/workflows Revert Me: Manually install go 1.16 until github actions updates image 2021-03-01 14:19:14 +01:00
blorg Update to go v1.16 and embed more extensive default blorg.org 2021-03-01 14:10:34 +01:00
etc Migrate from travisci to github actions 2021-01-02 20:42:59 +01:00
org html: Add support for #+TOC keyword 2021-03-28 17:12:25 +02:00
.gitignore Migrate from travisci to github actions 2021-01-02 20:42:59 +01:00
go.mod Update to go v1.16 and embed more extensive default blorg.org 2021-03-01 14:10:34 +01:00
go.sum Update to go v1.16 and embed more extensive default blorg.org 2021-03-01 14:10:34 +01:00
LICENSE Add MIT License 2018-12-20 20:30:14 +01:00
main.go Update to go v1.16 and embed more extensive default blorg.org 2021-03-01 14:10:34 +01:00
Makefile Add make preview & update README with basic development instructions 2019-09-22 02:02:32 +02:00
README.org Migrate from travisci to github actions 2021-01-02 20:42:59 +01:00

README.org

go-org

An Org mode parser and static site generator in go. Take a look at github pages

https://raw.githubusercontent.com/niklasfasching/go-org/master/etc/example.png

Please note

  • the goal for the html export is to produce sensible html output, not to exactly reproduce the output of org-html-export.
  • the goal for the parser is to support a reasonable subset of Org mode. Org mode is huge and I like to follow the 80/20 rule.

usage

command line 

$ go-org
USAGE: org COMMAND [ARGS]
- org render FILE OUTPUT_FORMAT
  OUTPUT_FORMAT: org, html, html-chroma
- org blorg init
- org blorg build
- org blorg serve

as a library

see main.go and hugo org/convert.go

development

  1. make setup install
  2. change things
  3. make preview (regenerates fixtures & shows output in a browser)

in general, have a look at the Makefile - it's short enough.

resources