File: README.rst

package info (click to toggle)
golang-github-hhatto-gorst 0.0~git20181029.ca9f730-3
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 436 kB
  • sloc: makefile: 38
file content (57 lines) | stat: -rw-r--r-- 1,229 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
gorst
=====

.. image:: https://travis-ci.org/hhatto/gorst.svg?branch=master
    :target: https://travis-ci.org/hhatto/gorst
    :alt: Build status

.. image:: https://godoc.org/github.com/hhatto/gorst?status.png
    :target: http://godoc.org/github.com/hhatto/gorst
    :alt: GoDoc

This is a Go_ implementation of reStructuredText_. developed on the basis of `Go markdown module implemented by Michael Teichgräber`_ .

Only Support for HTML output is implemented.

.. _reStructuredText: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
.. _Go: http://golang.org/
.. _`Go markdown module implemented by Michael Teichgräber`: https://github.com/knieriem/markdown

**This is experimental module. Highly under development.**


Installation
------------
.. code-block:: bash

    $ go get github.com/hhatto/gorst


Usage
-----
.. code-block:: go

    package main

    import (
        "bufio"
        "os"
        "github.com/hhatto/gorst"
    )

    func main() {
        p := rst.NewParser(nil)

        w := bufio.NewWriter(os.Stdout)
        p.ReStructuredText(os.Stdin, rst.ToHTML(w))
        w.Flush()
    }


TODO
----
* Simple Table
* Footnotes
* Citations
* Directives (figure, contents, ...)
* etc...