Skip to content

Latest commit

 

History

History
381 lines (265 loc) · 11.1 KB

CHANGELOG.md

File metadata and controls

381 lines (265 loc) · 11.1 KB

Change Log

This project uses semantic versioning.

[2.4.1] 2023-04-05

Fix bug with titles in image syntax in includes extension.

[2.4.0] 2022-11-30

Pick up the latest marked-it-core and add support for subscript and superscript.

[2.3.3] 2022-10-31

Pick up the latest marked-it-core and add support for bracket syntax for span tags, with a --disable-spans option to disable this new functionality on the command line.

[2.3.2] 2022-10-31

Pick up the latest marked-it-core.

[2.3.1] 2022-10-24

Fix in variables resolution and updates to example/includesExt.js.

[2.3.0] 2022-10-20

Add support for generating task lists and add warnings for unresolved variables.

[2.2.2] 2022-10-12

Fix variable substitution bug.

[2.2.1] 2022-10-06

Updates to example/includesExt.js.

[2.2.0] 2022-09-15

  1. Added support for specifying a per-repo "keyref.yaml" file. If this file is found in a source repository's root directory then it is parsed and its defined values are applied to variables encountered within the repo.
  2. Added two extension points:
    • process.onExit: Provides an opportunity for extensions to perform any required cleanup.
    • file.dir.files.get: Enables extensions to specify the ordered list of files and directories to be processed.

[2.1.3] 2022-08-26

Pick up the latest marked-it-core.

[2.1.2] 2022-08-15

Fix replaceVariables() problem.

[2.1.1] 2022-08-11

Fix toc generation exception.

[2.1.0] 2022-08-10

Add md.variables.add and toc.get extension points.

[2.0.2] 2022-03-03

Include topicgroup id values in generated TOC when present.

[2.0.1] 2022-02-17

Pick up the latest marked-it-core and fix package-lock.json.

[2.0.0] 2021-12-07

Version 2.0. Makes markdown-it the default underlying HTML generator.

[0.29.13] 2021-12-01

Fix bug with TOC processing of labels that look like markdown filenames.

[0.29.12] 2021-11-30

Update generated ids within conrefs to include "-include-".

[0.29.11] 2021-11-29

Make all id values contained within conrefs unique per consumer, to eliminate duplicated id's across topics.

[0.29.10] 2021-10-27

Rename conkeyref to keyref throughout.

[0.29.9] 2021-10-05

Pick up the latest marked-it-core.

[0.29.8] 2021-09-29

Pick up the latest marked-it-core.

[0.29.7] 2021-09-28

Fix regression in detection of code block bounds, and pick up the latest marked-it-core.

[0.29.6] 2021-09-23

Pick up the latest marked-it-core.

[0.29.5] 2021-09-22

Fix detection of code block bounds, and pick up the latest marked-it-core.

[0.29.4] 2021-09-17

Pick up the latest marked-it-core.

[0.29.3] 2021-09-16

Fix parsing of conref files in absence of conkeyref file.

[0.29.1 and 0.29.2] 2021-09-15

Fix parsing of conref files containing code blocks and pick up the latest marked-it-core.

[0.29.0] 2021-09-09

Added support for reading conref markdown content from a root-level conref.md file (v2 only).

[0.28.4 and 0.28.5] 2021-09-07

Pick up the latest marked-it-core.

[0.28.2 and 0.28.3] 2021-08-27

Pick up the latest marked-it-core.

[0.28.1] 2021-08-24

Allow links without topics in toc.yaml files.

[0.28.0] 2021-08-23

Add support for updated toc.yaml schema.

[0.27.0] 2021-08-18

Turn on the markdown-it typographer.

[0.26.4] 2021-08-17

Pick up the latest marked-it-core.

[0.26.2 and 0.26.3] 2021-08-11

Pick up the latest marked-it-core.

[0.26.1] 2021-08-10

Pick up the latest marked-it-core.

[0.26.0] 2021-08-09

Added the ability to override TOC title with a navtitle attribute in toc.yaml.

[0.25.7] 2021-07-27

Fixed TOC generation problem and version detection when using toc.yaml.

[0.25.6] 2021-07-23

Pick up the latest marked-it-core.

[0.25.5] 2021-07-23

Pick up the latest marked-it-core.

[0.25.4] 2021-07-21

Pick up the latest marked-it-core.

[0.25.3] 2021-07-19

Code block syntax styling fix.

[0.25.2] 2021-07-16

Code block syntax styling updates.

[0.25.1] 2021-07-12

Reference newer marked-it dependency.

[0.25.0] 2021-06-24

Add support for YAML-formatted toc files.

[0.24.3] 2021-01-18

Update example/jsonTocExt.js.

[0.24.2] 2020-12-07

Update the highlight.js dependency.

[0.24.1] 2020-12-02

Update the highlight.js dependency.

[0.24.0] 2020-11-09

Stop auto-fixing invalid headers.

[0.23.0] 2020-09-21

Added extension point styling.code.syntax.getAdditionalLanguages.

[0.22.4] 2020-08-05

Added mp4 to the list of file types copied from the source to destination.

[0.22.3] 2020-07-13

example/videoExt.js: Add support for output='iframe'.

[0.22.2] 2020-06-17

example/videoExt.js: Act if video is present as an attribute or as a class.

[0.22.1] 2020-06-02

Added example/videoExt.js mime type determination.

[0.22.0] 2020-06-02

Added example/videoExt.js.

[0.21.2] 2020-05-27

Update highlight.js dependency.

[0.21.1] 2020-04-16

Update js-yaml dependency.

[0.21.0] 2020-04-16

Added support for topicgroup-id in examples/jsonTocExt.js.

[0.20.4] 2020-03-09

Print the version string at startup.

[0.20.3] 2020-03-07

Picked up the latest marked-it fixes.

[0.20.2] 2020-03-07

Fixed ALD detection regex.

[0.20.1] 2019-10-11

Fixed package-lock.json.

[0.20.0] 2019-10-11

Exposed the core generator's new ability to generate footnotes that follow the syntax described at https://www.markdownguide.org/extended-syntax/#footnotes.

[0.19.1] 2019-09-13

example/accessibilityExt.js: Made generation of table summary text ids deterministic.

[0.19.0] 2019-08-23

Replace reading of extension init data from conref files to reading it from generic command-line args of form --@<extensionId>:<name>=<value>.

[0.18.1] 2019-08-15

Bug fix for previous release.

[0.18.0] 2019-08-15

Added passing of extension-data from a conref file to extension init() functions.

[0.17.4] 2019-05-16

example/accessibilityExt.js: Added aria-describedby to tables with summary texts.

[0.17.3] 2019-04-24

example/accessibilityExt.js: Added support for table summary attribute.

[0.17.2] 2019-04-03

Released fixes to a couple of example extensions.

[0.17.1] 2019-03-27

Released updated package-lock.json.

[0.17.0] 2019-03-27

Added escape and unescape functions to the data passed to some types of extensions.

[0.16.2] 2019-03-26

example/accessibilityExt.js: Added support for table row headers.

[0.16.1] 2019-03-20

example/accessibilityExt.js: Added support for

caption-side attribute.

[0.16.0] 2019-03-19

Picked up the latest marked-it changes, and augment example/accessibilityExt.js.

[0.15.0] 2019-02-13

Picked up the latest marked-it changes, which include adoption of marked v0.3.9.

[0.14.2] 2019-02-08

Picked up the latest marked-it fixes.

[0.14.1] 2019-01-28

Added checking of the file.dir.shouldProcess extension point during TOC generation.

[0.14.0] 2019-01-23

Added extension points file.dir.shouldProcess, file.md.shouldGenerate and file.shouldCopy.

[0.13.7] 2019-01-15

Changed how topic ids are computed, to use subcollection.

[0.13.6] 2018-12-07

Fixed: Variables defined in front matter are not being substituted into generated headers/footers.

[0.13.2 - 0.13.5] 2018-11-21

Fixed the computation of a TOC id's root folder segment.

[0.13.1] 2018-11-20

Added 'id' attributes on TOC topics.

[0.13.0] 2018-11-07

Modified creation of toc links to folders that do not exist locally.

[0.12.0] 2018-10-30

Enabled creation of toc links to folders that do not exist locally if the link path is absolute.

[0.11.0] 2018-10-16

Added a path attribute on the data object that gets passed to xml.toc.file.onGenerate and json.toc.file.onGenerate extension implementations. The "examples" extensions that implement these extension points now prefix generated hrefs with the received path value.

[0.10.8] 2018-10-11

Unescape topic labels in JSON TOCs.

[0.10.7] 2018-10-11

Consume the latest marked-it-core.

[0.10.6] 2018-10-05

Modified example/generateSectionsExt.js to move header attributes into containing section element.

[0.10.5] 2018-09-26

Consume the latest marked-it-core.

[0.10.4] 2018-09-24

Added example/generateSectionsExt.js.

[0.10.3] 2018-08-13

Fix the CHANGELOG.

[0.10.2] 2018-08-13

Bump up required version of marked-it-core package.

[0.10.1] 2018-08-13

Merged fixes for example/makeApidocsJson.js.

[0.10.0] 2018-08-13

New features

Support has been added for generating TOCs in JSON format. To use this, specify command-line arguments --toc-json --extension-file=./example/jsonTocExt.js, and toc.json files will be written for directories whose source contains a toc file.

There is also a new extension point, json.toc.file.onGenerate, which is analagous to the existing xml.toc.file.onGenerate extension point.

[0.9.7] 2018-06-25

Merged fix for example/makeApidocsJson.js.

[0.9.6] 2018-06-12

Added example/makeApidocsJson.js.

[0.9.5] 2018-05-10

Fix to skip processing of hidden folders/files.

[0.9.4] 2018-04-18

Fix to eliminate generation of <property name="class" value=""/> elements in toc.xml files.

[0.9.2] 2018-04-03

Update to example/xmlTocExt.js.

[0.9.1] 2017-06-27

New features

Code blocks that identify a source language are now marked up with highlight.js so that they can render with syntax highlighting. For example, markdown source: python s = "Python syntax highlighting" print s

will generate to HTML as:

<pre>
<code class="lang-python hljs">
s = <span class="hljs-string">"Python syntax highlighting"</span>
<span class="hljs-keyword">print</span> s
</code>
</pre>

[0.9.0] 2017-06-05

New features

Improved toc file nesting

Nesting of items in toc files can now be specified with '>' characters instead of whitespace. This was done because the previous reliance on whitespace proved to not be reliable, as specified whitespace was not always preserved by copy/paste operations and by display in some web clients.

The following is done to determine the indentation level for a line in a toc file:

  1. Capture all leading space and ‘>’ chars.
  2. If there are any ‘>’ chars in there then count the number of ‘>’ chars to determine that item’s level. All contained spaces are consequently considered to be meaningless (useful for formatting only).
  3. If there are no ‘>’ chars in there then use the previous approach of counting the number of leading spaces.

The following four hierarchies are equivalent. They demonstrate different approaches that can be used to define toc file lines with varying hierarchy readability.

root1 (spaces only)
    child1
            childTooDeepError
    child2
        child21
            child211
        child 22

root2 ('>' only)
>child1
>>>childTooDeepError
>child2
>>child21
>>>child211
>>child 22

root3 (all '>' at beginning, spaces are ignored but help with readability)
>    child1
>>>            childTooDeepError
>    child2
>>        child21
>>>            child211
>>        child 22

root4 ('>' at each level, spaces are ignored but help with readability)
>    child1
>    >    >    childTooDeepError
>    child2
>    >    child21
>    >    >    child211
>    >    child 22

[0.8.0] 2017-05-07

Initial release