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
229 commits 1 branch 0 tags 626 KiB
Find a file
Niklas Fasching 7344ea2e86 Add version flag 
go 1.18 embeds vcs info into binaries by default [1] allowing us to provide a
rudimentary version cmd in just a few lines. (version) vcs tags are not
embedded for now - just the commit hash should be good enough for now though.

[1] https://tip.golang.org/doc/go1.18
2022-03-27 01:20:09 +01:00
.github/workflows Revert "Manually install go 1.16 until github actions updates image" 2021-03-28 17:23:05 +02:00
blorg Update chroma to 0.10.0 2022-02-28 00:37:53 -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 Add version flag 2022-03-27 01:20:09 +01:00
go.sum Update chroma to 0.10.0 2022-02-28 00:37:53 -05:00
LICENSE Add MIT License 2018-12-20 20:30:14 +01:00
main.go Add version flag 2022-03-27 01:20:09 +01:00
Makefile README: Remove deprecated install target and check for go in setup 2022-03-19 18:39:14 +01:00
README.org README: Remove deprecated install target and check for go in setup 2022-03-19 18:39:14 +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
  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