mmark

command module
v1.9.982 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 27, 2018 License: BSD-2-Clause Imports: 14 Imported by: 0

README


title: "About" date: 2018-07-22T14:05:51+01:00 aliases: [/about/]

Build Status

Mmark is a powerful markdown processor written in Go, geared towards writing IETF documents. It is, however, also suited for writing complete books and other technical documentation, like the Learning Go book (mmark source).

It provides an advanced markdown dialect that processes file(s) to produce internet-drafts in XML RFC 7991 format. Mmark can produce xml2rfc (aforementioned RFC 7991), RFC 7749 (xml2rfc version 2) and HTML5 output.

Example RFCs can be found in the Github repository.

Mmark uses gomarkdown which is a fork of blackfriday.

If you like Go and parsing text, drop me (mailto:miek@miek.nl) a line if you want to be part of the Mmarkdown Github org, and help develop Mmark!

Syntax

Mmark's syntax and the extra features compared to plain Markdown are detailed in syntax.md.

Mmark adds the following syntax elements to gomarkdown/markdown:

Usage

You can download a binary or optionally build mmark your self. You'll need a working Go environment, then check out the code and:

% go get && go build
% ./mmark -version
2.0.0

To output XML2RFC v3 xml just give it a markdown file and:

% ./mmark rfc/3514.md

Making a draft in text form (v3 output)

% ./mmark rfc/3514.md > x.xml
% xml2rfc --v3 --text x.xml

Making a draft in text form (v2 output)

% ./mmark -2 rfc/3514.md > x.xml
% xml2rfc --text x.xml

Outputting HTML5 is done with the -html switch. Outputting RFC 7749 is done with -2.

Example RFC

The rfc/ directory contains a couple of example RFCs that can be build via the v2 or v3 tool chain. The build the text files, just run:

cd rfc
make txt

For v2 (i.e. the current (2018) way a making RFC), just run:

cd rfc
make TWO="yes" txt

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
reference
Package reference defines the elements of a <reference> block.
Package reference defines the elements of a <reference> block.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL