OrgWiki/go-org-orgwiki
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add make preview & update README with basic development instructions

Browse source 
not sure how helpful this really this but something is better than nothing i
guess
This commit is contained in:
Niklas Fasching 2019-09-22 01:58:48 +02:00
parent a143b04826
commit de302bbc0a
2 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Makefile
View file

@ -17,6 +17,10 @@ test: install
setup: setup:
git config core.hooksPath etc/githooks git config core.hooksPath etc/githooks
.PHONY: preview
preview: generate
xdg-open gh-pages/index.html
.PHONY: generate .PHONY: generate
generate: generate-gh-pages generate-fixtures generate: generate-gh-pages generate-fixtures

6
README.org
View file

@ -3,6 +3,12 @@ An Org mode parser in go.
Take a look at [[https://niklasfasching.github.io/go-org/][github pages]] for some examples and an online org -> html demo (wasm based). Take a look at [[https://niklasfasching.github.io/go-org/][github pages]] for some examples and an online org -> html demo (wasm based).
[[https://raw.githubusercontent.com/niklasfasching/go-org/master/etc/example.png]] [[https://raw.githubusercontent.com/niklasfasching/go-org/master/etc/example.png]]
Please note that the goal for the html export is to produce sensible html output, not to exactly reproduce output the output of =org-html-export=. Please note that the goal for the html export is to produce sensible html output, not to exactly reproduce output the output of =org-html-export=.
* 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.
* not yet implemented * not yet implemented
** deadlines and scheduling ** deadlines and scheduling
see https://orgmode.org/manual/Deadlines-and-scheduling.html see https://orgmode.org/manual/Deadlines-and-scheduling.html