stitchmd

Stitch multiple Markdown files together into a single document.

GPL-2.0 License

Stars
30

Bot releases are visible (Hide)

stitchmd - v0.9.0 Latest Release

Published by github-actions[bot] 4 months ago

Added

  • Included files can add absorb: true to their YAML front matter to include their headings in the summary TOC automatically.
stitchmd - v0.8.1

Published by abhinav 12 months ago

v0.8.1 - 2023-11-08

Fixed

  • Fix included summaries not adjusting item heading levels based on the include's position in the list.
stitchmd - v0.8.0

Published by abhinav 12 months ago

v0.8.0 - 2023-11-07

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.

Added

  • Add -unsafe flag to reference files outside the current directory.
  • Summary files now support including other summary files with the syntax ![Title](file.md).

Changed

  • Paths to files in error messages are relative to the input directory.
stitchmd - v0.7.0

Published by github-actions[bot] over 1 year ago

Added

  • Transform relative links in <img> and <a> tags.
stitchmd - v0.6.0

Published by github-actions[bot] over 1 year ago

Added

  • Support external links in summary. These will be rendered verbatim.

Changed

  • Relicense under GPL-2.0.

Fixed

  • For headers too deep to be represented in Markdown, render an anchor and bold text.
stitchmd - v0.5.0

Published by github-actions[bot] over 1 year ago

Added

  • Support stripping TOML front matter in addition to YAML.
    TOML front matter is marked by +++.
stitchmd - v0.4.0

Published by github-actions[bot] over 1 year ago

Added

  • -diff flag as an alias for -d.
  • -preface flag to include contents of another file in the output verbatim.

Changed

  • The output of -d is now colored by default if stdout is a terminal.
    Disable with --color=never, or by setting NO_COLOR=1.
stitchmd - v0.3.0

Published by github-actions[bot] over 1 year ago

Added

  • -d flag to print a diff of the output
    instead of writing to the output file.
stitchmd - v0.2.0

Published by github-actions[bot] over 1 year ago

Added

  • -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.

Changed

  • -o now creates the output directory if it does not exist.
stitchmd - v0.1.1

Published by github-actions[bot] over 1 year ago

Fixed

  • Fix corner cases with text in the summary getting merged.
  • Fix link rewriting on Windows.
stitchmd - v0.1.0

Published by github-actions[bot] over 1 year ago

Initial release

Package Rankings
Top 9.26% on Proxy.golang.org
Badges
Extracted from project README
CI codecov