Skip to content
This repository has been archived by the owner on Mar 24, 2021. It is now read-only.

demizer/go-rst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jan 20, 2018
76354a4 · Jan 20, 2018
Sep 17, 2017
Jan 20, 2018
Jan 20, 2018
Sep 14, 2017
Jun 9, 2017
Sep 14, 2017
Jun 19, 2017
Dec 2, 2014
Feb 6, 2014
Jan 20, 2018
Jan 20, 2018
Apr 18, 2017
Jun 20, 2017
Apr 18, 2017
Jun 9, 2017

Repository files navigation

go-rst - reStructuredText for Go

https://travis-ci.org/demizer/go-rst.svg?branch=master https://coveralls.io/repos/github/demizer/go-rst/badge.svg?branch=master https://goreportcard.com/badge/github.com/demizer/go-rst

A reStructuredText parser for the Go Programming Language.

This project is not yet usable. See the Road Map below.

Status

ABANDONED

I no longer have interest in working on this in my spare time. RestructuredText is not an easy format to parse and I no longer write my notes in the format.

go-rst implements 10% of the official specification (28 of 283 Items)

See implementation status for a breakdown of what's implemented.

There is also a Road Map.

Usage

This library does not have any functionality beyond running parser tests.

Tests

From the root of the project,

GO_RST_SKIP_NOT_IMPLEMENTED=1 go test -v ./pkg/...

There are many tests that are imported from docutils, but not implemented yet.

How to contribute

See the doc directory for more documentation and tip and tricks.