Skip to content

Commit

Permalink
fix(md-aggregate): postversion
Browse files Browse the repository at this point in the history
  • Loading branch information
snomiao committed Jul 3, 2022
1 parent 155b9d1 commit 7b9cdf7
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 94 deletions.
92 changes: 0 additions & 92 deletions packages/md-aggregate/CHANGELOG.md
Expand Up @@ -120,95 +120,3 @@ Note: This section is orginally written in CHANGELOG.md file and is merged into
## 0.0.2 (2022-04-20)

**Note:** Version bump only for package md-aggregate

## MD-Aggregate

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

### Install

```shell
npm i -g md-aggregate
```

### Usage

```plaintext
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

```markdown
### README.md

### OTHER

...OTHER
```

and CHANGELOG.md like this

```markdown
### CHANGE LOG

### x.x.x

...CHANGELOG
```

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

```markdown
### README

### OTHER

...OTHER

### CHANGE LOG

#### x.x.x

...CHANGELOG

...
```

### About

#### License

GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)

#### Author

Author: snomiao <snomiao@gmail.com>
Website: [snomiao.com](https://snomiao.com)

#### Sponsors

- None yet.

Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>

#### Contribute

The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.
4 changes: 2 additions & 2 deletions packages/md-aggregate/package.json
@@ -1,6 +1,6 @@
{
"name": "md-aggregate",
"version": "2.1.3",
"version": "2.1.4",
"description": "Aggregate README.md with CHANGELOG.md or whatever",
"keywords": [
"markdown",
Expand Down Expand Up @@ -37,7 +37,7 @@
"scripts": {
"build": "snobuild --lib",
"prepack": "npm run build",
"postversion": "prettier -w CHANGELOG.md && md-aggregate CHANGELOG.md README.md -w"
"postversion": "prettier -w CHANGELOG.md && npm link && md-aggregate README.md CHANGELOG.md -w"
},
"dependencies": {
"escape-string-regexp": "^5.0.0",
Expand Down

0 comments on commit 7b9cdf7

Please sign in to comment.