-
Notifications
You must be signed in to change notification settings - Fork 181
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): updated changelog script
- Loading branch information
Showing
10 changed files
with
232 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
var copyfiles = require('copyfiles'); | ||
|
||
const changelogs = [ | ||
{ | ||
from: '../packages/typedoc-plugin-markdown/CHANGELOG.md', | ||
to: 'pages/docs', | ||
}, | ||
{ | ||
from: '../packages/typedoc-vitepress-theme/CHANGELOG.md', | ||
to: 'pages/plugins/vitepress', | ||
}, | ||
{ | ||
from: '../packages/docusaurus-plugin-typedoc/CHANGELOG.md', | ||
to: 'pages/plugins/docusaurus', | ||
}, | ||
{ | ||
from: '../packages/typedoc-plugin-remark/CHANGELOG.md', | ||
to: 'pages/plugins/remark', | ||
}, | ||
{ | ||
from: '../packages/typedoc-plugin-frontmatter/CHANGELOG.md', | ||
to: 'pages/plugins/frontmatter', | ||
}, | ||
]; | ||
|
||
changelogs.forEach(({ from, to }) => { | ||
copyfiles([from, to], { up: 3 }, () => {}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Changelog | ||
|
||
## 1.2.0 (2024-12-30) | ||
|
||
### Minor Changes | ||
|
||
- Strikeout deprecated items in sidebar ([#747](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/747)). | ||
|
||
## 1.1.1 (2024-12-03) | ||
|
||
### Patch Changes | ||
|
||
- Allow additional plugins to be loaded via the "plugin" key. | ||
|
||
## 1.1.0 (2024-11-27) | ||
|
||
### Minor Changes | ||
|
||
- [email protected] / [email protected] support | ||
|
||
## 1.0.5 (2024-08-08) | ||
|
||
### Patch Changes | ||
|
||
- Fix missing sidebar children for categories | ||
|
||
## 1.0.4 (2024-07-22) | ||
|
||
### Patch Changes | ||
|
||
- Fix base sidebar ids in windows ([#657](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/657)) | ||
|
||
## 1.0.3 (2024-07-10) | ||
|
||
### Patch Changes | ||
|
||
- Correctly handle sidebar ids with custom docs paths ([#648](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/648)) | ||
|
||
## 1.0.2 (2024-07-01) | ||
|
||
### Patch Changes | ||
|
||
- Create output directory if it doesn't exist ([#641](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/641)) | ||
|
||
## 1.0.1 (2024-05-07) | ||
|
||
### Patch Changes | ||
|
||
- Handle windows path separators when generating sidebar ids | ||
|
||
## 1.0.0 (2024-05-03) | ||
|
||
> v1 is a major release that includes a number of improvements. | ||
### Architectural Changes | ||
|
||
- typedoc-plugin-markdown must be updated to V4. | ||
- `category.yml` files are no longer written. | ||
- Frontmatter is no longer included by default. | ||
|
||
### Breaking Changes | ||
|
||
- A manual sidebar file should be referenced in `sidebars.js` rather than autogenerated configuration as previously recommended. | ||
- `includeExtension` has been removed as this behaviour is now the default. | ||
- `frontmatter` option has been removed. Please use `typedoc-plugin-frontmatter`. | ||
- `sidebar` options `position` and `categoryLabel` are no longer relevant and have been removed. | ||
|
||
### Bug Fixes | ||
|
||
- Correctly handle sidebar ids in Windows ([#597](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/597)). | ||
- Provide exit code on process error ([#583](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/583)) | ||
- Use correct path separator in sidebar urls ([#489](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/489)) | ||
- Fail docusaurus build when TypeDoc errors - can be overridden with `skipErrorChecking` ([#429](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/429)). | ||
|
||
--- | ||
|
||
Earlier changelog entries can be found in `CHANGELOG_ARCHIVE.md`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Changelog | ||
|
||
## 1.1.2 (2024-12-11) | ||
|
||
### Patch Changes | ||
|
||
- Export PluginOptions for external use ([#737](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/737)). | ||
|
||
## 1.1.1 (2024-12-11) | ||
|
||
- Empty release due to unintended publication. | ||
|
||
## 1.1.0 (2024-11-27) | ||
|
||
### Minor Changes | ||
|
||
- [email protected] / [email protected] support | ||
|
||
## 1.0.0 (2024-05-03) | ||
|
||
- First major release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Changelog | ||
|
||
## 1.2.4 (2025-01-02) | ||
|
||
### Patch Changes | ||
|
||
- Fix typedoc-plugin-markdown 4.0.0 compatibility. | ||
|
||
## 1.2.3 (2025-01-01) | ||
|
||
### Patch Changes | ||
|
||
- Fix windows ERR_UNSUPPORTED_ESM_URL_SCHEME error ([#752](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/752)). | ||
|
||
## 1.2.2 (2024-12-23) | ||
|
||
### Patch Changes | ||
|
||
- Remove heading count restriction when adding toc placeholder heading (for usage with remark-toc). | ||
|
||
## 1.2.1 (2024-12-11) | ||
|
||
### Patch Changes | ||
|
||
- Export PluginOptions for external use ([#737](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/737)) | ||
|
||
## 1.2.0 (2024-12-09) | ||
|
||
### Minor Changes | ||
|
||
- Exposed "defaultRemarkPlugins" option to configure which remark plugins are loaded by default ([#735](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/735)). | ||
|
||
## 1.1.1 (2024-12-03) | ||
|
||
### Patch Changes | ||
|
||
- Resolve local plugins from `process.cwd()`. | ||
|
||
## 1.1.0 (2024-11-27) | ||
|
||
### Minor Changes | ||
|
||
- [email protected] / [email protected] support | ||
|
||
## 1.0.3 (2024-08-15) | ||
|
||
### Patch Changes | ||
|
||
- Updated table formatting with typedoc-plugin-markdown "htmlTable" key. | ||
|
||
## 1.0.2 (2024-06-22) | ||
|
||
### Patch Changes | ||
|
||
- Add toc from remark-tocs to document reflections | ||
- Normalize tables output | ||
|
||
## 1.0.1 (2024-05-27) | ||
|
||
### Patch Changes | ||
|
||
- Additionally parse with "remark-mdx" to retain escaped angle brackets ([#622](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/622)) | ||
|
||
## 1.0.0 (2024-05-03) | ||
|
||
- First major release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Changelog | ||
|
||
## 1.1.2 (2025-01-07) | ||
|
||
### Patch Changes | ||
|
||
- Correctly handle base sidebar paths in windows ([#756](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/756)). | ||
|
||
## 1.1.1 (2024-12-02) | ||
|
||
### Patch Changes | ||
|
||
- Updated anchor slugs to correctly handle all use-cases. | ||
|
||
## 1.1.0 (2024-11-27) | ||
|
||
### Minor Changes | ||
|
||
- [email protected] / [email protected] support | ||
|
||
## 1.0.2 (2024-09-30) | ||
|
||
### Patch Changes | ||
|
||
- Fix sidebar links when "out" and "docsRoot" are the same value ([#695](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/695)) | ||
|
||
## 1.0.1 (2024-07-02) | ||
|
||
### Patch Changes | ||
|
||
- Normalize sidebar paths in windows ([#643](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/643)) | ||
|
||
## 1.0.0 (2024-05-03) | ||
|
||
- First major release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,9 +18,9 @@ | |
|
||
- [email protected] / [email protected] support | ||
|
||
## 1.0.2 | ||
## 1.0.2 (2024-09-30) | ||
|
||
### Patch Changes (2024-09-30) | ||
### Patch Changes | ||
|
||
- Fix sidebar links when "out" and "docsRoot" are the same value ([#695](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/695)) | ||
|
||
|