Skip to content

Commit

Permalink
Update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
krisztianb committed Apr 23, 2023
1 parent f7899f9 commit c715cf1
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 12 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [4.1.0] - 2022-04-23
### Changes
- Added support for latest TypeDoc version 0.24.x.

## [4.0.1] - 2022-07-09
### Fixed
- Plugin doesn't rename certain types of default exports.
Expand Down Expand Up @@ -55,7 +59,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

First release

[unreleased]: https://github.com/krisztianb/typedoc-plugin-merge-modules/compare/v4.0.1...HEAD
[unreleased]: https://github.com/krisztianb/typedoc-plugin-merge-modules/compare/v4.1.0...HEAD
[4.1.0]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v4.1.0
[4.0.1]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v4.0.1
[4.0.0]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v4.0.0
[3.1.0]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v3.1.0
Expand Down
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ Use cases:
* If you want to document an entire application and not a library, you can specify all files that you want to have documented as entry points for TypeDoc and use this plugin to merge all modules into the project root removing the extra module layer.
* If you want to merge the content of some modules in the TypeDoc output, you can use this plugin and [module annotations](https://typedoc.org/guides/doccomments/#files) in your files to specify which modules should be combined.

## Example

When running TypeDoc with two module files `module1.ts` and `module2.ts` as entry points produces the following result:

![Before](https://raw.githubusercontent.com/krisztianb/typedoc-plugin-merge-modules/master/doc/before-example.png)

Using this plugin will make the result look like this:

![After](https://raw.githubusercontent.com/krisztianb/typedoc-plugin-merge-modules/master/doc/after-example.png)

## Installation

This module can be installed using [npm](https://www.npmjs.com/package/typedoc-plugin-merge-modules):
Expand All @@ -17,18 +27,12 @@ This module can be installed using [npm](https://www.npmjs.com/package/typedoc-p
$ npm install typedoc-plugin-merge-modules --save-dev
```

TypeDoc automatically detects plugins installed via npm. After installation TypeDoc can be used normally and you can
configure this plugin as described below.
The plugin requires TypeDoc version 0.23.x or 0.24.x to be installed.

## Example
Version **0.23.x** of TypeDoc automatically detects plugins installed via npm.
If you are using version **0.24.x** of TypeDoc you need to [activate the plugin with a command line argument](https://typedoc.org/options/configuration/#plugin).

When running TypeDoc with two module files `module1.ts` and `module2.ts` as entry points produces the following result:

![Before](https://raw.githubusercontent.com/krisztianb/typedoc-plugin-merge-modules/master/doc/before-example.png)

Using this plugin will make the result look like this:

![After](https://raw.githubusercontent.com/krisztianb/typedoc-plugin-merge-modules/master/doc/after-example.png)
After installation TypeDoc can be used normally and you can configure this plugin as described below.

## Options

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "typedoc-plugin-merge-modules",
"version": "4.0.2",
"version": "4.1.0",
"description": "Plugin for TypeDoc that merges the content of modules.",
"author": {
"name": "Krisztián Balla",
Expand Down

0 comments on commit c715cf1

Please sign in to comment.