Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
27 additions
and
2 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
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 |
---|---|---|
|
@@ -4,4 +4,5 @@ export default { | |
sidebar: '', | ||
'multi-instance': '', | ||
'watch-mode': '', | ||
'migration-guide': '', | ||
}; |
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,24 @@ | ||
import { Callout } from 'nextra/components'; | ||
|
||
# 🚀 Migration Guide v1 | ||
|
||
<Callout> | ||
docusaurus-plugin-typedoc@v4 is a major release that includes a number of bug | ||
fixes, new features and UX improvements. | ||
</Callout> | ||
|
||
## Architectural Changes | ||
|
||
- typedoc-plugin-markdown must be updated to V4. | ||
- `category.yml` files are no longer written. | ||
- Frontmatter is no longer included by default. | ||
|
||
## Sidebar Configuration | ||
|
||
- A manual sidebar file should now be referenced in `sidebars.js` rather than autogenerated configuration as previously recommended. Please See [sidebar guide](/plugins/docusaurus/sidebar). | ||
|
||
## Options Changes | ||
|
||
- `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. |
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