Update blorg and add it to gh-pages. Update README
This commit is contained in:
parent
e076412b29
commit
d2bbcc8881
21 changed files with 746 additions and 103 deletions
19
README.org
19
README.org
|
@ -1,14 +1,25 @@
|
|||
* go-org [[https://travis-ci.org/niklasfasching/go-org.svg?branch=master]]
|
||||
An Org mode parser in go. And soon a blog generator.
|
||||
Take a look at [[https://niklasfasching.github.io/go-org/][github pages]] for some examples and to try it out live in your browser.
|
||||
An Org mode parser and static site generator in go.
|
||||
Take a look at github pages
|
||||
- for [[https://niklasfasching.github.io/go-org/][org to html conversion]] examples
|
||||
- for a [[https://niklasfasching.github.io/go-org/blorg][static site]] generated by blorg
|
||||
- to [[https://niklasfasching.github.io/go-org/convert.html][try it out live]] in your browser
|
||||
|
||||
[[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
|
||||
#+begin_src
|
||||
go-org
|
||||
#+begin_src bash
|
||||
$ 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
|
||||
#+end_src
|
||||
** as a library
|
||||
see [[https://github.com/niklasfasching/go-org/blob/master/main.go][main.go]] and hugo [[https://github.com/gohugoio/hugo/blob/master/markup/org/convert.go][org/convert.go]]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue