Skip to content

Commit fab4810

Browse files
committed
Version 2.0.0
Signed-off-by: Miek Gieben <[email protected]>
1 parent 6d5e5a9 commit fab4810

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

Diff for: README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ It provides an advanced markdown dialect that processes file(s) to produce inter
1414
[RFC 7991](https://tools.ietf.org/html/rfc7991) format. Mmark can produce xml2rfc (aforementioned
1515
RFC 7991), RFC 7749 (xml2rfc version 2) and HTML5 output.
1616

17-
Example RFCs can be [found in the Github repository](https://github.com/mmarkdown/mmark/tree/master/rfc).
17+
Example RFCs in Mmark format can be [found in the Github
18+
repository](https://github.com/mmarkdown/mmark/tree/master/rfc).
1819

1920
Mmark uses [gomarkdown](https://github.com/gomarkdown/markdown) which is a fork of
2021
[blackfriday](https://github.com/russross/blackfriday/).
@@ -38,8 +39,8 @@ Mmark adds the following syntax elements to
3839
* [Document divisions](https://mmark.nl/syntax#document-divisions).
3940
* [Captions](https://mmark.nl/syntax#captions) for code, tables and quotes
4041
* [Asides](https://mmark.nl/syntax#asides).
41-
* [Figures and Subfigures](https://mmark.nl/syntax#figures-and-subfigures) - this syntax is still under consideration as is
42-
"do we really need this?"
42+
* [Figures and Subfigures](https://mmark.nl/syntax#figures-and-subfigures) - bundle (sub)figures
43+
into a larger figure.
4344
* [Block Level Attributes](https://mmark.nl/syntax#block-level-attributes) that allow to specify attributes, classes and
4445
IDs for elements.
4546
* [Indices](https://mmark.nl/syntax#indices) to mark an item (and/or a subitem) to be referenced in the document index.
@@ -88,7 +89,7 @@ cd rfc
8889
make txt
8990
~~~
9091

91-
For v2 (i.e. the current (2018) way a making RFC), just run:
92+
For v2 (i.e. the current (2018) way of making RFC), just run:
9293
~~~ sh
9394
cd rfc
9495
make TWO="yes" txt

Diff for: Syntax.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ aliases: [/syntax/]
55
toc: true
66
---
77

8-
This is version 2 of [Mmark](https://github.com/mmarkdown/mmark):
9-
based on a [new markdown implementation](https://github.com/mmarkdown/markdown)
10-
and some (small) language changes as well. We think these language changes lead to a more consistent
11-
user experience and lead to less confusion.
8+
This is version 2 of [Mmark](https://github.com/mmarkdown/mmark): based on a [new markdown
9+
implementation](https://github.com/mmarkdown/markdown) and some (small) language changes as well. We
10+
think these language changes lead to a more consistent user experience and lead to less confusion.
1211

1312
See [changes from v1](#changes-from-version-1) if you're coming from version 1.
1413

@@ -49,7 +48,7 @@ article](https://notes.peter-baumgartner.net/archive/content-organisation/blackf
4948
5049
For the rest we build up on <https://github.com/gomarkdown/markdown> and support all syntax
5150
[it supports](https://github.com/gomarkdown/markdown/blob/master/README.md). We enable the following
52-
extensions by default:
51+
[extensions](https://github.com/gomarkdown/markdown/blob/master/README.md#extensions) by default:
5352

5453
* *Strikethrough*, allow strike through text using `~~test~~`.
5554
* *Autolink*, detect embedded URLs that are not explicitly marked.
@@ -61,7 +60,7 @@ extensions by default:
6160
* *OrderedListStart*, notice start element of ordered list.
6261
* *Attributes*, allow block level attributes.
6362
* *Smartypants*, expand `--` and `---` into ndash and mdashes.
64-
* *SuperSubscript*, parse super and subscript: H~2~O is water and 2^10^ is 1024.
63+
* *SuperSubscript*, parse super- and subscript: H~2~O is water and 2^10^ is 1024.
6564
* *Tables*, parse tables.
6665

6766
Mmark adds numerous enhancements to make it suitable for writing ([IETF](https://ietf.org)) Internet
@@ -80,10 +79,10 @@ Drafts and even complete books. It <strike>steals</strike> borrows syntax elemen
8079

8180
Mmark adds:
8281

83-
* (Extended) [title block](#title-block).
84-
* [Special sections](#special-sections).
82+
* (Extended) [title block](#title-block) to specify authors and IETF specific bits.
83+
* [Special sections](#special-sections), for abstracts or notes.
8584
* [Including other files](#including-files) with the option to specify line ranges, regular
86-
expressions and/or prefix each line with a string.
85+
expressions and/or prefix each line with a custom string.
8786
* [Document divisions](#document-divisions).
8887
* [Captions](#captions) for code, tables, quotes and subfigures.
8988
* [Asides](#asides).
@@ -177,8 +176,8 @@ Title Block:
177176
*Area* defaults to "Internet" and *Ipr* defaults to `trust200902`.
178177

179178
BCP 14/RFC 2119 Keywords:
180-
: If an RFC 2119 word is found enclosed in `**` it will be rendered normally
181-
i.e. `**MUST**` becomes `MUST`.
179+
: If an RFC 2119 word is found enclosed in `**` it will be rendered normally i.e. `**MUST**`
180+
becomes `MUST`.
182181

183182
Artwork/Source code:
184183
: There is no such distinction so these will be rendered in the same way regardless.

Diff for: version.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
package main
22

33
// Version of mmark.
4-
var Version = "1.9.982"
4+
var Version = "2.0.0"

0 commit comments

Comments
 (0)