MD-Aggregate

Aggregate README.md with CHANGELOG.md or whatever.md.

Install

npm i -g md-aggregate

Usage

md-aggregate <target> [input..]

aggregate markdown files

Options:
  -w, --write    write mode (when missing you will get preview in console)
                                                                     [boolean]  -i, --input    source markdown files                                 [array]  -t, --target   destination markdown file                            [string]  -h, --help     Show help                                           [boolean]  -v, --version  Show version number                                 [boolean]

Examples:
  preview:   md-aggregate README.md CHANGELOG.md
  one:       md-aggregate README.md CHANGELOG.md -w
  multi:     md-aggregate README.md ABOUT.md LICENSE.md CHANGELOG.md -w
  multi:     md-aggregate README.md -i ABOUT.md -i LICENSE.md -i CHANGELOG.md
             -w

Description

Insert markdown documents into one document, and level up the titles,

For Example, you have README.md like this

# README.md

## OTHER

...OTHER

and CHANGELOG.md like this

# CHANGE LOG

## x.x.x

...CHANGELOG

It will be append or replaced into README.md like this:

# README

## OTHER

...OTHER

## CHANGE LOG

### x.x.x

...CHANGELOG

...

About

License

MIT License - The MIT License – Open Source Initiative

Author

Author: snomiao [e-mail] Website: snomiao.com

Sponsors

• None yet.

Claim your sponsorship by donating snomiao <Email: [e-mail]>

Contribute

The main repo is in here, any issue and PR's welcome.

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.3.0 (2024-07-17)

Features

• escapeStringRegexp (debe2a6)
• md-aggregate: multi input (39789fd)
• pkg: snobuild v3 (0d8fd4d)

Bug Fixes

• add prettier and selflink to CHANGELOG.md (cca75ac)
• all: update docs (c8fc9c8)
• apply md-aggregate (7319ef7)
• apply write md-aggregate (d677cab)
• bump versions (c856549)
• js: build deps (e4466e7)
• main: allow url (0f1b669)
• md-aggregate: imports (8205318)
• md-aggregate: postversion (e89287b)
• md-aggregate: prepublishOnly (d2179da)
• md-aggregate: prettier deps (bd27603)
• md-aggregate: remove symlink due to permission issue (03406d5)
• md-aggregate: use esbuild (41f3ed3)
• md-aggregate: use snobuild and update docs (603697a)
• md-aggregate: wrap with aiife (95ea618)
• package: prepublishonly (930fcad)
• replace # => ## (8a53fca)
• snoval: rename pkg (eaf3c71)
• srcContentWithoutSectionStart (836bc4f)
• srcContentWithoutSectionStart (a0c09ce)
• writeFile in monopkgs (1812a4c)

2.2.0 (2023-01-08)

Bug Fixes

• md-aggregate: prepublishOnly (c93d0a8)
• package: prepublishonly (99dc7e6)

Features

• pkg: snobuild v3 (611805b)

2.1.8 (2022-07-03)

Bug Fixes

• md-aggregate: remove symlink due to permission issue (46e7fd6)

2.1.7 (2022-07-03)

Bug Fixes

• md-aggregate: prettier deps (a7cdff8)

2.1.6 (2022-07-03)

Bug Fixes

• bump versions (5919ed1)
• md-aggregate: imports (a80e012)
• md-aggregate: postversion (7b9cdf7)
• md-aggregate: wrap with aiife (155b9d1)

2.1.0 (2022-06-17)

Bug Fixes

• all: update docs (0c84651)
• md-aggregate: use esbuild (92b8891)
• md-aggregate: use snobuild and update docs (7acf192)
• snoval: rename pkg (3b86bf7)

Features

• md-aggregate: multi input (fcf0b6e)

Note: This section is orginally written in CHANGELOG.md file and is merged into README.md to show how this project works.

0.1.8 (2022-04-23)

Bug Fixes

• srcContentWithoutSectionStart (ec8f862)

0.1.7 (2022-04-23)

Bug Fixes

• replace # => ## (bfc6e79)
• srcContentWithoutSectionStart (3837654)

0.1.2 (2022-04-20)

Bug Fixes

• writeFile in monopkgs (d18e90a)

0.1.0 (2022-04-20)

Features

• escapeStringRegexp (a1263b3)

0.0.8 (2022-04-20)

Bug Fixes

• add prettier and selflink to CHANGELOG.md (df03f61)

0.0.7 (2022-04-20)

Bug Fixes

• apply write md-aggregate (2aa4291)

0.0.5 (2022-04-20)

Bug Fixes

• apply md-aggregate (2343a8d)