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
208 commits 1 branch 0 tags 626 KiB
Find a file
Niklas Fasching e5ae608865 Improve Makefile: Only install dependencies and rebuild when required 
By getting rid of the PHONY install and bundling the go get with its uses we
can prevent unnecessary go gets in `make build` - this speeds up development as
I run `make generate-fixtures` a lot and fetching dependencies takes
comparatively long.

We also add the `-d` flag to go get to get rid of the deprecation warning
```
go get: installing executables with 'go get' in module mode is deprecated.
	To adjust and download dependencies of the current module, use 'go get -d'.
	To install using requirements of the current module, use 'go install'.
	To install ignoring the current module, use 'go install' with a version,
	like 'go install example.com/cmd@latest'.
	For more information, see https://golang.org/doc/go-get-install-deprecation
	or run 'go help get' or 'go help install'.
```
2021-04-17 15:48:41 +02:00
.github/workflows Revert "Manually install go 1.16 until github actions updates image" 2021-03-28 17:23:05 +02: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 Add support for custom numbering of ordered list using [@\d+] 2021-04-17 15:43:19 +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 Improve Makefile: Only install dependencies and rebuild when required 2021-04-17 15:48:41 +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