https://github.com/hhatto/gorst

Go implementation of reStructuredText
https://github.com/hhatto/gorst

go parser rest restructuredtext

Last synced: about 1 month ago
JSON representation

Go implementation of reStructuredText

• Host: GitHub
• URL: https://github.com/hhatto/gorst
• Owner: hhatto
• License: other
• Created: 2014-10-23T07:37:05.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-10-29T13:32:15.000Z (about 6 years ago)
• Last Synced: 2024-11-09T19:50:21.586Z (about 1 month ago)
• Topics: go, parser, rest, restructuredtext
• Language: Go
• Homepage:
• Size: 207 KB
• Stars: 35
• Watchers: 9
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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...