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
223 commits 1 branch 0 tags 626 KiB
Find a file
Elliott Sales de Andrade 1122a3dfbc Make blorg tests more verbose 
By not combining all files into one md5sum.
2022-02-27 15:44:52 -05:00
.github/workflows Revert "Manually install go 1.16 until github actions updates image" 2021-03-28 17:23:05 +02:00
blorg Make blorg tests more verbose 2022-02-27 15:44:52 -05:00
etc Update stylesheet to handle unwrapped list items 2021-07-20 22:24:29 +02:00
org Support fast tags by trimming the key binding. 2021-10-28 17:23:19 +02:00
.gitignore Migrate from travisci to github actions 2021-01-02 20:42:59 +01:00
go.mod build: update go directive in go.mod to 1.17 2022-01-07 09:08:56 +08:00
go.sum build: update go directive in go.mod to 1.17 2022-01-07 09:08:56 +08:00
LICENSE Add MIT License 2018-12-20 20:30:14 +01:00
main.go cli: Fix support for reading input from stdin - prefer file input 2021-12-26 23:25:30 +01:00
Makefile make: fix preview command 2021-07-13 22:13:58 +02:00
README.org cli: Support reading input from stdin 2021-12-26 23:17:19 +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: go-org COMMAND [ARGS]...
Commands:
- render [FILE] FORMAT
  FORMAT: org, html, html-chroma
  Instead of specifying a file, org mode content can also be passed on stdin
- blorg
  - blorg init
  - blorg build
  - 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