A go org syntax parser to html
Go
Clone or download
wd and chaseadamsio Fix #61 (#74)
* fix #61

* fix bugs
Latest commit dcf1ef8 Nov 26, 2017
Permalink
Failed to load latest commit information.
Godeps add go deps; blackfriday at v2.0.0 (#69) Oct 16, 2017
testdata
.gitignore
.travis.yml remove repo token for coveralls (#45) Apr 27, 2017
LICENSE
README.org Fixed README examples (#57) Oct 10, 2017
goorgeous.go Fix #61 (#74) Nov 26, 2017
goorgeous_test.go Fix #61 (#74) Nov 26, 2017
gopher.gif
gopher_small.gif
header.go
header_test.go allow frontmatter to be cased based on user input rather than title case Feb 22, 2017

README.org

chaseadamsio/goorgeous

https://travis-ci.org/chaseadamsio/goorgeous.svg?branch=master https://coveralls.io/repos/github/chaseadamsio/goorgeous/badge.svg?branch=master

goorgeous is a Go Org to HTML Parser.

gopher_small.gif

Pronounced: Go? Org? Yes!

“Org mode is for keeping notes, maintaining TODO lists, planning projects, and authoring documents with a fast and effective plain-text system.”

The purpose of this package is to come as close as possible as parsing an *.org document into HTML, the same way one might publish with org-publish-html from Emacs.

Installation

go get -u github.com/chaseadamsio/goorgeous

Usage

Org Headers

To retrieve the headers from a []byte, call OrgHeaders and it will return a map[string]interface{}:

input := "#+title: goorgeous\n* Some Headline\n"
out, _ := goorgeous.OrgHeaders(input) 
map[string]interface{}{ 
        "title": "goorgeous"
}

Org Content

After importing github.com/chaseadamsio/goorgeous, you can call Org with a []byte and it will return an html version of the content as a []byte

input := "#+TITLE: goorgeous\n* Some Headline\n"
out := goorgeous.OrgCommon([]byte(input)) 

out will be:

<h1>Some Headline</h1>/n

Why?

First off, I’ve become an unapologetic user of Emacs & ever since finding org-mode I use it for anything having to do with writing content, organizing my life and keeping documentation of my days/weeks/months.

Although I like Emacs & emacs-lisp, I publish all of my html sites with Hugo Static Site Generator and wanted to be able to write my content in org-mode in Emacs rather than markdown.

Hugo’s implementation of templating and speed are unmatched, so the only way I knew for sure I could continue to use Hugo and write in org-mode seamlessly was to write a golang parser for org content and submit a PR for Hugo to use it.

Acknowledgements

I leaned heavily on russross’ blackfriday markdown renderer as both an example of how to write a parser (with some updates to leverage the go we know today) and reusing the blackfriday HTML Renderer so I didn’t have to write my own!