All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, adheres to Semantic Versioning, and is generated by Changie.
- Included files can add
absorb: true
to their YAML front matter to include their headings in the summary TOC automatically.
- Fix included summaries not adjusting item heading levels based on the include's position in the list.
This release adds new syntax:
- ![Title](file.md)
Use this form inside a summary file to recursively include the contents of another summary file under the given title.
- Add -unsafe flag to reference files outside the current directory.
- Summary files now support including other summary files with the syntax
![Title](file.md)
.
- Paths to files in error messages are relative to the input directory.
- Transform relative links in
<img>
and<a>
tags.
- Support external links in summary. These will be rendered verbatim.
- Relicense under GPL-2.0.
- For headers too deep to be represented in Markdown, render an anchor and bold text.
- Support stripping TOML front matter in addition to YAML.
TOML front matter is marked by
+++
.
-diff
flag as an alias for-d
.-preface
flag to include contents of another file in the output verbatim.
- The output of
-d
is now colored by default if stdout is a terminal. Disable with--color=never
, or by settingNO_COLOR=1
.
-d
flag to print a diff of the output instead of writing to the output file.
-offset N
flag to offset all headings by a fixed amount (positive or negative).-no-toc
flag to stop the table of contents from being rendered in the output.
-o
now creates the output directory if it does not exist.
- Fix corner cases with text in the summary getting merged.
- Fix link rewriting on Windows.
- Initial release.