Commit 0525256a965ef44f3d32f0835f2f9bfa0778b099 - golang-github-miekg-mmark

Import upstream version 1.3.6+dfsg+git20180823.1.4a11391 Debian Janitor 2 years ago

1 changed file(s) with 10 addition(s) and 4 deletion(s). Raw diff Collapse all Expand all

+10

-4

README.md less more

	0	# !THIS REPOSITORY IS DEPRECATED!
	1
	2	A new version of mmark can be found at <https://github.com/mmarkdown/mmark>. Its new main site
	3	is <https://mmark.nl>.
	4
	5
0	6	# Mmark
1	7
2		Mmark is a powerful markdown processor Go geared towards writing IETF documents. It is, however,
	8	Mmark is a powerful markdown processor written in Go geared towards writing IETF documents. It is, however,
3	9	also suited for writing books and other technical documentation.
4	10
5	11	Further documentation can be [found at my site](https://miek.nl/tags/mmark/). A complete syntax
6	12	document [can be found here](https://github.com/miekg/mmark/wiki/Syntax).
7	13
8		With Mmark your can write RFCs using markdown. Mmark (written in Go) provides an advanced markdown
	14	With Mmark you can write RFCs using markdown. Mmark (written in Go) provides an advanced markdown
9	15	dialect that processes a (single) file to produce internet-drafts in XML format. Internet-drafts
10	16	written in mmark can produce xml2rfc v2, xml2rfc v3 and HTML5 output.
11	17

87	93
88	94	% docker run --rm -v $(pwd):/rfc paulej/rfctools mmark -xml2 -page mmark2rfc.md
89	95
90		Making a draft in text form:
	96	Making a draft in text form:
91	97
92	98	% docker run --rm -v $(pwd):/rfc paulej/rfctools mmark -xml2 -page mmark2rfc.md >x.xml \
93	99	&& docker run --rm -v $(pwd):/rfc -v $HOME/.cache/xml2rfc:/var/cache/xml2rfc \

101	107	Note also that the xml2rfc program will write an output file that will be owned by "root".
102	108	To prevent that (and the cache files) from being owned by root, we instruct docker to run
103	109	using the user's default user ID and group ID via the --user switch.
104
	110
105	111	There is a script available called "md2rfc" simplifies the above to this:
106	112
107	113	% docker run --rm -v $(pwd):/rfc -v $HOME/.cache/xml2rfc:/var/cache/xml2rfc \