diff --git a/README.md b/README.md index 6bc340a1..bec31fe7 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ [glossarify-md]: https://github.com/about-code/glossarify-md +[mdast]: https://github.com/syntax-tree/mdast + [micromark]: https://github.com/micromark/ [pandoc-heading-ids]: https://pandoc.org/MANUAL.html#heading-identifiers @@ -56,6 +58,7 @@ - [Lists](#lists) - [List of Figures](#list-of-figures) - [List of Tables](#list-of-tables) + - [Lists from Regular Expressions](#lists-from-regular-expressions) - [Markdown Syntax Extensions](#markdown-syntax-extensions) - [Node Support Matrix](#node-support-matrix) - [Options](#options) @@ -106,7 +109,12 @@ Generate a configuration with the `--init` option: npx glossarify-md --init > glossarify-md.conf.json ``` -*glossarify-md.conf.json (minimal)* +- use `--init` to generate a config. + - add `--new` to create a `./docs/glossarify.md` and write config into `./glossarify-md.conf.json` + - add `--more` to generate a config with more [options] and default values + - add `--local` to load the config schema from the `node_modules` directory + +*glossarify-md.conf.json (`glossarify-md --init`)* ```json { @@ -116,11 +124,6 @@ npx glossarify-md --init > glossarify-md.conf.json } ``` -- use `--init` to generate a config\` - - add `--new` to create a `./docs/glossarify.md` and write config into `./glossarify-md.conf.json` - - add `--more` to generate a config with more [options] and default values - - add `--local` to load the config schema from the `node_modules` directory - *glossarify-md.conf.json* (`glossarify-md --init --local`) ```json @@ -391,7 +394,7 @@ The i18n-object is passed *as is* to the collator function. Thus you can use add **Too many links?** -What might happen with*globs* is, that once a lot of headings become terms, you might feel that *too many links* are being generated, disturbing the reading experience. If this is an issue for you explore [`linking.*`][opt-linking] options like `linking.mentions`, `linking.limitByAlternatives` or `linking.headingDepths` to tweak linkify behavior. +What might happen with *globs* is, that once a lot of headings exist, you might feel that *too many links* are being generated, disturbing the reading experience. If this is an issue for you explore [`linking.*`][opt-linking] options like `linking.mentions`, `linking.limitByAlternatives` or `linking.headingDepths` to tweak linkify behavior. ### Identifier-based Cross-Linking @@ -495,7 +498,7 @@ More details see our video tutorial: ``` -Then to generate a *List of Videos* add to your *glossarify-md.conf.json*: +Then to generate a *List of Videos* from all elements of `class="video"` add to your *glossarify-md.conf.json*: ```json "generateFiles": { @@ -519,16 +522,16 @@ You can **type less** when prefixing ids with your list classifier: ```md ``` -Without a `title` attribute the tool attempts to derive a list item title from an elements text content: +Without a `title` attribute the tool attempts to derive a list item label from an elements inner text content: ```md - ``` -Then to generate a *List of Videos* add to your *glossarify-md.conf.json*: +Then to generate a *List of Videos* from all elements of `class="video"` add to your *glossarify-md.conf.json*: ```json "generateFiles": { @@ -476,16 +479,16 @@ You can **type less** when prefixing ids with your list classifier: ~~~md ~~~ -Without a `title` attribute the tool attempts to derive a list item title from an elements text content: +Without a `title` attribute the tool attempts to derive a list item label from an elements inner text content: ~~~md -