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
235 commits 1 branch 0 tags 626 KiB
Find a file
Niklas Fasching 338dfae4f1 Remove goorgeous comparison 
`go mod tidy` kept including goorgeous and blackfriday for me - turns out go
does not honor gitignore [1] and the correct way of ignoring a subdirectory is to
place an empty `go.mod` file in it [2]. As I haven't looked in that file for
quite some time and goorgeous has been deprecated let's rather just get rid of
the comparison altogether.

[1] the .go file requiring goorgeous was placed into `docs/`
    when running `make generate-gh-pages`. `docs/` is gitignored but not
    ignored by go
[2] https://github.com/golang/go/wiki/Modules#can-an-additional-gomod-exclude-unnecessary-content-do-modules-have-the-equivalent-of-a-gitignore-file
2022-05-31 14:31:31 +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 chroma: v0.10.0 -> v2 2022-05-30 17:31:54 +02:00
etc Remove goorgeous comparison 2022-05-31 14:31:31 +02:00
org Fix html entities: support \<entity>{} and prevent partial replacements 2022-04-28 18:09:42 +02:00
.gitignore Migrate from travisci to github actions 2021-01-02 20:42:59 +01:00
go.mod Update chroma: v0.10.0 -> v2 2022-05-30 17:31:54 +02:00
go.sum Update chroma: v0.10.0 -> v2 2022-05-30 17:31:54 +02:00
LICENSE Add MIT License 2018-12-20 20:30:14 +01:00
main.go Update chroma: v0.10.0 -> v2 2022-05-30 17:31:54 +02:00
Makefile make: Add serve-gh-pages target 2022-05-30 17:31:54 +02: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