https://github.com/matthewdargan/rst

Basic reStructuredText parser
https://github.com/matthewdargan/rst

go golang lexer parser restructuredtext

Last synced: about 1 year ago
JSON representation

Basic reStructuredText parser

• Host: GitHub
• URL: https://github.com/matthewdargan/rst
• Owner: matthewdargan
• License: bsd-3-clause
• Created: 2023-12-28T23:05:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-06T21:41:23.000Z (about 2 years ago)
• Last Synced: 2025-03-29T17:45:17.929Z (about 1 year ago)
• Topics: go, golang, lexer, parser, restructuredtext
• Language: Go
• Homepage:
• Size: 1.17 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# rst

[![GoDoc](https://godoc.org/github.com/matthewdargan/rst?status.svg)](https://godoc.org/github.com/matthewdargan/rst)

[![Build Status](https://github.com/matthewdargan/rst/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/matthewdargan/rst/actions/workflows/go.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/matthewdargan/rst)](https://goreportcard.com/report/github.com/matthewdargan/rst)

[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](LICENSE)

![reStructuredCats](doc/images/cats-transparent.png)

Package rst implements a reStructuredText parser. Refer to the

[reStructuredText Primer](https://docutils.sourceforge.io/docs/user/rst/quickref.html)

and [reStructuredText Markup Specification](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html)

documents to implement the parser.

Work in progress.

## Tests

[docutils unit tests](https://repo.or.cz/docutils.git/tree/HEAD:/docutils/test/test_parsers/test_rst)

test the parser.

## reStructuredCats

The rst mascots, Cheese, Butters, and Scoop, watch over the project and were

designed by Dasol Dargan. The [cat images](doc/images) are Creative Commons

Attribution 4.0 licensed, which means you can use them but must provide credit

to their creator.