Skip to content

Commit

Permalink
doc: Wording
Browse files Browse the repository at this point in the history
  • Loading branch information
about-code committed Feb 20, 2021
1 parent 3d1d6fd commit e57d1ce
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 18 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -696,7 +696,9 @@ key: This is a frontmatter
---
```

Without special support for it our Markdown parser ([remark]) will recognise the line of trailing dashes as Markdown syntax for a *heading*. To make it aware that they contribute to syntax for a *frontmatter* we need to enhance the parser. **Since v5.0.0** we have opened [glossarify-md] to the [remark plug-in ecosystem][remark-plugins] and its extensive support of additional syntaxes and tools:
Without special support for it our Markdown parser ([remark]) will interpret the line of trailing dashes as Markdown syntax for a *heading*. To make it aware that they contribute to syntax for a *frontmatter* we need to enhance the parser. **Since v5.0.0** we have opened [glossarify-md] to the [remark plug-in ecosystem][remark-plugins] and its extensive support of additional syntaxes and tools:

> **Note:** glossarify-md must not be held responsible for issues arising due to installing and using additional plug-ins.
*Add this to your glossarify-md.conf.json*

Expand Down Expand Up @@ -727,16 +729,14 @@ and make remark load the plug-in by adding to your *remark.conf.json*:
}
```

> **Note:** glossarify-md must not be held responsible for issues arising due to installing and using additional plug-ins.
`remark.conf.json` follows the [unified configuration][unified-config] schema:

- `remark-frontmatter` must be the name of the npm package you installed before.
- Any properties of the object are specific to the plug-in.

The configuration could also be embedded into a *glossarify-md.conf.json*. But keep in mind that anything under the `unified` key is a [unified configuration][unified-config] whose schema is *not* subject to the [glossarify-md] config schema.
You could also embed the configuration in a *glossarify-md.conf.json*. But keep in mind that anything under the `unified` key is a different schema and *not* subject to the [glossarify-md] config schema.

> **[unified], [remark], uhh..**
> **[remark], [unified], uhh... ?**
>
> Read more on how these projects relate to glossarify-md in our [Addendum: Conceptual Layers](https://github.com/about-code/glossarify-md/blob/master/doc/conceptual-layers.md)
Expand Down
9 changes: 6 additions & 3 deletions demo/conceptual-layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ Conceptual layers and projects contributing to the layer
| 3 | [unified] | umbrella project for *text file processing in general* |
| 2 | [remark] | unified *processor* for *markdown text file processing in particular* |
| 1 | [micromark] | remarks internal markdown syntax tokenizer |
| 0 | [CommonMark] | Markdown Syntax Specification for your files |
| 0 | [CommonMark] | Informal Markdown Syntax Specification |

[glossarify-md] is built on [unified], an umbrella project for *text file processing in general*. We use [unified] with [remark], which in conceptual terms of [unified] is a *processor* for *Markdown text files in particular*. [remark] itself only supports the [CommonMark] specification via its *internal* [micromark] parser/tokenizer.

[glossarify-md] is built on [unified], an umbrella project for *text file processing in general*. We use [unified] with [remark], which in conceptual terms of [unified] is a *processor* for *Markdown text files in particular*.
That's why you need to install additional [remark plug-ins][remark-plugins] when you need extended Markdown syntax. Those plug-ins then usually install and depend on a [micromark] extension to parse and tokenize that syntax. We omitted for simplicity that [glossarify-md] already installs [remark-gfm] to also support popular [GitHub Flavoured Markdown][GFM] syntax (e.g. tables) and [remark-footnote] (footnotes).

**When installing [remark plug-ins][remark-plugins]** you might need to know the remark version in use: *[glossarify-md] is already on [remark] 13+ with [micromark].* [micromark] is the parser/tokenizer implementation **internal** to [remark] as of version 13. Unless told you by any [remark plug-in][remark-plugins] you won't likely have to install any micromark extensions yourself when using [glossarify-md]. Just stick with [remark plug-ins][remark-plugins] on layers 2. They should declare their [micromark] requirements for themselves.
Unless told you by any [remark plug-in][remark-plugins] you won't likely have to install any micromark extensions yourself when using [glossarify-md]. Just stick with [remark plug-ins][remark-plugins] on layer 2. They should declare their [micromark] requirements for themselves.


[glossarify-md]: https://github.com/about-code/glossarify-md
Expand All @@ -22,3 +23,5 @@ Conceptual layers and projects contributing to the layer
[remark-plugins]: https://github.com/remarkjs/awesome-remark
[unified]: https://unifiedjs.com
[CommonMark]: https://commonmark.org
[GFM]: https://github.github.com/gfm/
[remark-footnotes]: https://npmjs.com/package/remark-footnotes
14 changes: 9 additions & 5 deletions doc/conceptual-layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ Conceptual layers and projects contributing to the layer
| 3 | [unified] | umbrella project for *text file processing in general* |
| 2 | [remark] | [unified↴][1] *processor* for *markdown text file processing in particular* |
| 1 | [micromark] | remarks internal markdown syntax tokenizer |
| 0 | [CommonMark] | Markdown Syntax Specification for your files |
| 0 | [CommonMark] | Informal Markdown Syntax Specification |

[glossarify-md] is built on [unified], an umbrella project for *text file processing in general*. We use [unified] with [remark], which in conceptual terms of [unified] is a *processor* for *Markdown text files in particular*.
[glossarify-md] is built on [unified], an umbrella project for *text file processing in general*. We use [unified] with [remark], which in conceptual terms of [unified] is a *processor* for *Markdown text files in particular*. [remark] itself only supports the [CommonMark] specification via its *internal* [micromark] parser/tokenizer.

**When installing [remark plug-ins][remark-plugins]** you might need to know the [remark↴][2] version in use: *[glossarify-md] is already on [remark] 13+ with [micromark].* [micromark] is the parser/tokenizer implementation **internal** to [remark] as of version 13. Unless told you by any [remark plug-in][remark-plugins] you won't likely have to install any micromark extensions yourself when using [glossarify-md]. Just stick with [remark plug-ins][remark-plugins] on layers 2. They should declare their [micromark] requirements for themselves.
That's why you need to install additional [remark plug-ins][remark-plugins] when you need extended Markdown syntax. Those plug-ins then usually install and depend on a [micromark] extension to parse and tokenize that syntax. We omitted for simplicity that [glossarify-md] already installs \[remark-gfm] to also support popular [GitHub Flavoured Markdown][GFM] syntax (e.g. tables) and \[remark-footnote] (footnotes).

Unless told you by any [remark plug-in][remark-plugins] you won't likely have to install any micromark extensions yourself when using [glossarify-md]. Just stick with [remark plug-ins][remark-plugins] on layer 2. They should declare their [micromark] requirements for themselves.

[glossarify-md]: https://github.com/about-code/glossarify-md

Expand All @@ -26,6 +28,8 @@ Conceptual layers and projects contributing to the layer

[CommonMark]: https://commonmark.org

[1]: ./glossary.md#unified "unified is an umbrella project around text file processing in general."
[GFM]: https://github.github.com/gfm/

[2]: ./glossary.md#remark "remark is a parser and compiler project under the unified umbrella for Markdown text files in particular."
[remark-footnotes]: https://npmjs.com/package/remark-footnotes

[1]: ./glossary.md#unified "unified is an umbrella project around text file processing in general."
11 changes: 6 additions & 5 deletions md/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -656,7 +656,9 @@ key: This is a frontmatter
---
```

Without special support for it our Markdown parser ([remark]) will recognise the line of trailing dashes as Markdown syntax for a *heading*. To make it aware that they contribute to syntax for a *frontmatter* we need to enhance the parser. **Since v5.0.0** we have opened [glossarify-md] to the [remark plug-in ecosystem][remark-plugins] and its extensive support of additional syntaxes and tools:
Without special support for it our Markdown parser ([remark]) will interpret the line of trailing dashes as Markdown syntax for a *heading*. To make it aware that they contribute to syntax for a *frontmatter* we need to enhance the parser. **Since v5.0.0** we have opened [glossarify-md] to the [remark plug-in ecosystem][remark-plugins] and its extensive support of additional syntaxes and tools:

> **Note:** glossarify-md must not be held responsible for issues arising due to installing and using additional plug-ins.
*Add this to your glossarify-md.conf.json*

Expand Down Expand Up @@ -687,20 +689,19 @@ and make remark load the plug-in by adding to your *remark.conf.json*:
}
```

> **Note:** glossarify-md must not be held responsible for issues arising due to installing and using additional plug-ins.
`remark.conf.json` follows the [unified configuration][unified-config] schema:

- `remark-frontmatter` must be the name of the npm package you installed before.
- Any properties of the object are specific to the plug-in.

The configuration could also be embedded into a *glossarify-md.conf.json*. But keep in mind that anything under the `unified` key is a [unified configuration][unified-config] whose schema is *not* subject to the [glossarify-md] config schema.
You could also embed the configuration in a *glossarify-md.conf.json*. But keep in mind that anything under the `unified` key is a different schema and *not* subject to the [glossarify-md] config schema.

> **[unified], [remark], uhh..**
> **[remark], [unified], uhh... ?**
>
> Read more on how these projects relate to glossarify-md in our [Addendum: Conceptual Layers](https://github.com/about-code/glossarify-md/blob/master/doc/conceptual-layers.md)


## Node Support Matrix

The term *support* refers to *runs on the given platform* and is subject to the terms and conditions in [LICENSE](#license).
Expand Down

0 comments on commit e57d1ce

Please sign in to comment.