From e13d28532dd5cd69752d5c6dcb61a3b18d017d27 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Thu, 2 May 2024 21:21:39 +0100 Subject: [PATCH] chore(global): version packages for release --- .changeset/afraid-fans-study.md | 7 - .changeset/angry-cars-wash.md | 5 - .changeset/big-cooks-lick.md | 5 - .changeset/big-ties-dance.md | 5 - .changeset/brave-cows-clean.md | 5 - .changeset/breezy-avocados-lie.md | 5 - .changeset/bright-pumpkins-tie.md | 5 - .changeset/brown-mangos-rhyme.md | 8 - .changeset/brown-years-deliver.md | 5 - .changeset/chilled-owls-call.md | 7 - .changeset/chilled-suits-beg.md | 5 - .changeset/chilly-insects-relax.md | 6 - .changeset/clean-jobs-fetch.md | 5 - .changeset/clean-snakes-cough.md | 5 - .changeset/clever-maps-rescue.md | 5 - .changeset/cuddly-games-pull.md | 5 - .changeset/curvy-pillows-guess.md | 7 - .changeset/cyan-islands-tap.md | 6 - .changeset/dirty-walls-serve.md | 6 - .changeset/dry-pans-perform.md | 7 - .changeset/eight-fireants-relate.md | 9 - .changeset/eighty-ladybugs-lick.md | 7 - .changeset/fair-apples-happen.md | 5 - .changeset/fair-rice-smoke.md | 6 - .changeset/famous-islands-compare.md | 5 - .changeset/fast-hotels-rescue.md | 5 - .changeset/five-buses-vanish.md | 5 - .changeset/five-cobras-bake.md | 7 - .changeset/five-worms-remain.md | 5 - .changeset/fluffy-teachers-search.md | 5 - .changeset/forty-cows-jam.md | 5 - .changeset/four-bugs-fail.md | 5 - .changeset/four-fishes-film.md | 5 - .changeset/fresh-forks-poke.md | 5 - .changeset/funny-news-hug.md | 7 - .changeset/fuzzy-clocks-whisper.md | 6 - .changeset/fuzzy-news-decide.md | 7 - .changeset/giant-mails-rest.md | 6 - .changeset/great-phones-fetch.md | 5 - .changeset/green-lions-walk.md | 6 - .changeset/happy-rats-help.md | 8 - .changeset/heavy-snakes-press.md | 7 - .changeset/hip-moose-allow.md | 5 - .changeset/honest-actors-call.md | 5 - .changeset/hungry-papayas-punch.md | 5 - .changeset/itchy-seals-count.md | 5 - .changeset/khaki-dogs-cheat.md | 5 - .changeset/kind-deers-push.md | 5 - .changeset/kind-monkeys-grow.md | 5 - .changeset/large-feet-shout.md | 5 - .changeset/late-bikes-unite.md | 5 - .changeset/late-keys-whisper.md | 6 - .changeset/lazy-taxis-camp.md | 5 - .changeset/lemon-spiders-taste.md | 5 - .changeset/light-steaks-count.md | 5 - .changeset/little-rats-end.md | 5 - .changeset/long-crabs-own.md | 5 - .changeset/long-frogs-divide.md | 7 - .changeset/lovely-needles-tap.md | 5 - .changeset/lucky-crabs-sin.md | 5 - .changeset/lucky-ears-fix.md | 5 - .changeset/lucky-jokes-switch.md | 9 - .changeset/many-bulldogs-give.md | 7 - .changeset/mean-fishes-buy.md | 5 - .changeset/mean-pears-camp.md | 5 - .changeset/metal-forks-exist.md | 7 - .changeset/mighty-deers-dress.md | 5 - .changeset/nasty-starfishes-ring.md | 5 - .changeset/nasty-swans-occur.md | 5 - .changeset/nervous-cherries-cry.md | 5 - .changeset/new-geckos-grow.md | 8 - .changeset/nice-goats-dress.md | 6 - .changeset/ninety-planets-type.md | 6 - .changeset/odd-kiwis-perform.md | 5 - .changeset/old-coats-reply.md | 5 - .changeset/olive-lies-divide.md | 5 - .changeset/olive-pianos-pretend.md | 5 - .changeset/olive-points-hug.md | 6 - .changeset/olive-socks-mate.md | 5 - .changeset/olive-suits-lick.md | 5 - .changeset/orange-teachers-rest.md | 6 - .changeset/perfect-ligers-help.md | 5 - .changeset/plenty-bees-worry.md | 7 - .changeset/polite-planets-knock.md | 10 - .changeset/polite-ways-hang.md | 6 - .changeset/poor-gorillas-march.md | 6 - .changeset/pre.json | 152 ------ .changeset/proud-feet-poke.md | 5 - .changeset/proud-houses-learn.md | 5 - .changeset/proud-houses-tie.md | 6 - .changeset/proud-mugs-pull.md | 8 - .changeset/quiet-birds-taste.md | 7 - .changeset/red-snails-jump.md | 8 - .changeset/rotten-owls-tap.md | 6 - .changeset/selfish-coins-bake.md | 6 - .changeset/selfish-socks-change.md | 5 - .changeset/shaggy-pens-end.md | 5 - .changeset/sharp-timers-brush.md | 5 - .changeset/shiny-ducks-lie.md | 5 - .changeset/silver-chicken-approve.md | 7 - .changeset/six-bottles-rescue.md | 5 - .changeset/six-coats-carry.md | 5 - .changeset/sixty-hornets-argue.md | 5 - .changeset/slow-worms-provide.md | 5 - .changeset/small-kangaroos-kick.md | 8 - .changeset/smart-spoons-kneel.md | 6 - .changeset/smooth-carrots-relate.md | 5 - .changeset/spicy-beans-leave.md | 5 - .changeset/spicy-students-fetch.md | 6 - .changeset/stale-coats-perform.md | 5 - .changeset/stale-suns-explain.md | 9 - .changeset/strong-toys-move.md | 5 - .changeset/strong-turtles-tan.md | 5 - .changeset/stupid-knives-scream.md | 5 - .changeset/sweet-poets-smell.md | 5 - .changeset/sweet-zebras-deliver.md | 6 - .changeset/swift-radios-remember.md | 5 - .changeset/tall-phones-protect.md | 5 - .changeset/tasty-timers-move.md | 5 - .changeset/ten-comics-own.md | 8 - .changeset/ten-numbers-tease.md | 5 - .changeset/ten-parrots-check.md | 5 - .changeset/thin-pigs-shout.md | 5 - .changeset/tough-houses-talk.md | 5 - .changeset/tricky-mayflies-pull.md | 6 - .changeset/twenty-cheetahs-enjoy.md | 5 - .changeset/twenty-moose-promise.md | 5 - .changeset/two-meals-fix.md | 7 - .changeset/warm-colts-deny.md | 5 - .changeset/weak-coins-sparkle.md | 5 - .changeset/wicked-experts-call.md | 5 - .changeset/witty-socks-invite.md | 5 - .changeset/young-jeans-exercise.md | 5 - .github/workflows/release.yml | 2 +- README.md | 18 +- devtools/examples/README.md | 2 +- devtools/scripts/generate-readmes.ts | 9 +- docs/pages/plugins/docusaurus/_meta.js | 9 - .../plugins/docusaurus/migration-guide.mdx | 11 - .../docusaurus-plugin-typedoc/CHANGELOG.md | 427 +--------------- .../CHANGELOG_ARCHIVE.md | 174 +++++++ .../docusaurus-plugin-typedoc/package.json | 4 +- .../typedoc-github-wiki-theme/CHANGELOG.md | 144 +----- .../typedoc-github-wiki-theme/package.json | 4 +- .../typedoc-gitlab-wiki-theme/CHANGELOG.md | 115 +---- .../typedoc-gitlab-wiki-theme/package.json | 4 +- .../typedoc-plugin-frontmatter/CHANGELOG.md | 30 +- .../typedoc-plugin-frontmatter/package.json | 4 +- packages/typedoc-plugin-markdown/CHANGELOG.md | 41 +- ...CHANGELOG_V3..md => CHANGELOG_ARCHIVE..md} | 454 ++---------------- packages/typedoc-plugin-markdown/package.json | 2 +- packages/typedoc-plugin-remark/CHANGELOG.md | 34 +- packages/typedoc-plugin-remark/package.json | 4 +- packages/typedoc-vitepress-theme/CHANGELOG.md | 98 +--- packages/typedoc-vitepress-theme/package.json | 4 +- 155 files changed, 284 insertions(+), 2213 deletions(-) delete mode 100644 .changeset/afraid-fans-study.md delete mode 100644 .changeset/angry-cars-wash.md delete mode 100644 .changeset/big-cooks-lick.md delete mode 100644 .changeset/big-ties-dance.md delete mode 100644 .changeset/brave-cows-clean.md delete mode 100644 .changeset/breezy-avocados-lie.md delete mode 100644 .changeset/bright-pumpkins-tie.md delete mode 100644 .changeset/brown-mangos-rhyme.md delete mode 100644 .changeset/brown-years-deliver.md delete mode 100644 .changeset/chilled-owls-call.md delete mode 100644 .changeset/chilled-suits-beg.md delete mode 100644 .changeset/chilly-insects-relax.md delete mode 100644 .changeset/clean-jobs-fetch.md delete mode 100644 .changeset/clean-snakes-cough.md delete mode 100644 .changeset/clever-maps-rescue.md delete mode 100644 .changeset/cuddly-games-pull.md delete mode 100644 .changeset/curvy-pillows-guess.md delete mode 100644 .changeset/cyan-islands-tap.md delete mode 100644 .changeset/dirty-walls-serve.md delete mode 100644 .changeset/dry-pans-perform.md delete mode 100644 .changeset/eight-fireants-relate.md delete mode 100644 .changeset/eighty-ladybugs-lick.md delete mode 100644 .changeset/fair-apples-happen.md delete mode 100644 .changeset/fair-rice-smoke.md delete mode 100644 .changeset/famous-islands-compare.md delete mode 100644 .changeset/fast-hotels-rescue.md delete mode 100644 .changeset/five-buses-vanish.md delete mode 100644 .changeset/five-cobras-bake.md delete mode 100644 .changeset/five-worms-remain.md delete mode 100644 .changeset/fluffy-teachers-search.md delete mode 100644 .changeset/forty-cows-jam.md delete mode 100644 .changeset/four-bugs-fail.md delete mode 100644 .changeset/four-fishes-film.md delete mode 100644 .changeset/fresh-forks-poke.md delete mode 100644 .changeset/funny-news-hug.md delete mode 100644 .changeset/fuzzy-clocks-whisper.md delete mode 100644 .changeset/fuzzy-news-decide.md delete mode 100644 .changeset/giant-mails-rest.md delete mode 100644 .changeset/great-phones-fetch.md delete mode 100644 .changeset/green-lions-walk.md delete mode 100644 .changeset/happy-rats-help.md delete mode 100644 .changeset/heavy-snakes-press.md delete mode 100644 .changeset/hip-moose-allow.md delete mode 100644 .changeset/honest-actors-call.md delete mode 100644 .changeset/hungry-papayas-punch.md delete mode 100644 .changeset/itchy-seals-count.md delete mode 100644 .changeset/khaki-dogs-cheat.md delete mode 100644 .changeset/kind-deers-push.md delete mode 100644 .changeset/kind-monkeys-grow.md delete mode 100644 .changeset/large-feet-shout.md delete mode 100644 .changeset/late-bikes-unite.md delete mode 100644 .changeset/late-keys-whisper.md delete mode 100644 .changeset/lazy-taxis-camp.md delete mode 100644 .changeset/lemon-spiders-taste.md delete mode 100644 .changeset/light-steaks-count.md delete mode 100644 .changeset/little-rats-end.md delete mode 100644 .changeset/long-crabs-own.md delete mode 100644 .changeset/long-frogs-divide.md delete mode 100644 .changeset/lovely-needles-tap.md delete mode 100644 .changeset/lucky-crabs-sin.md delete mode 100644 .changeset/lucky-ears-fix.md delete mode 100644 .changeset/lucky-jokes-switch.md delete mode 100644 .changeset/many-bulldogs-give.md delete mode 100644 .changeset/mean-fishes-buy.md delete mode 100644 .changeset/mean-pears-camp.md delete mode 100644 .changeset/metal-forks-exist.md delete mode 100644 .changeset/mighty-deers-dress.md delete mode 100644 .changeset/nasty-starfishes-ring.md delete mode 100644 .changeset/nasty-swans-occur.md delete mode 100644 .changeset/nervous-cherries-cry.md delete mode 100644 .changeset/new-geckos-grow.md delete mode 100644 .changeset/nice-goats-dress.md delete mode 100644 .changeset/ninety-planets-type.md delete mode 100644 .changeset/odd-kiwis-perform.md delete mode 100644 .changeset/old-coats-reply.md delete mode 100644 .changeset/olive-lies-divide.md delete mode 100644 .changeset/olive-pianos-pretend.md delete mode 100644 .changeset/olive-points-hug.md delete mode 100644 .changeset/olive-socks-mate.md delete mode 100644 .changeset/olive-suits-lick.md delete mode 100644 .changeset/orange-teachers-rest.md delete mode 100644 .changeset/perfect-ligers-help.md delete mode 100644 .changeset/plenty-bees-worry.md delete mode 100644 .changeset/polite-planets-knock.md delete mode 100644 .changeset/polite-ways-hang.md delete mode 100644 .changeset/poor-gorillas-march.md delete mode 100644 .changeset/pre.json delete mode 100644 .changeset/proud-feet-poke.md delete mode 100644 .changeset/proud-houses-learn.md delete mode 100644 .changeset/proud-houses-tie.md delete mode 100644 .changeset/proud-mugs-pull.md delete mode 100644 .changeset/quiet-birds-taste.md delete mode 100644 .changeset/red-snails-jump.md delete mode 100644 .changeset/rotten-owls-tap.md delete mode 100644 .changeset/selfish-coins-bake.md delete mode 100644 .changeset/selfish-socks-change.md delete mode 100644 .changeset/shaggy-pens-end.md delete mode 100644 .changeset/sharp-timers-brush.md delete mode 100644 .changeset/shiny-ducks-lie.md delete mode 100644 .changeset/silver-chicken-approve.md delete mode 100644 .changeset/six-bottles-rescue.md delete mode 100644 .changeset/six-coats-carry.md delete mode 100644 .changeset/sixty-hornets-argue.md delete mode 100644 .changeset/slow-worms-provide.md delete mode 100644 .changeset/small-kangaroos-kick.md delete mode 100644 .changeset/smart-spoons-kneel.md delete mode 100644 .changeset/smooth-carrots-relate.md delete mode 100644 .changeset/spicy-beans-leave.md delete mode 100644 .changeset/spicy-students-fetch.md delete mode 100644 .changeset/stale-coats-perform.md delete mode 100644 .changeset/stale-suns-explain.md delete mode 100644 .changeset/strong-toys-move.md delete mode 100644 .changeset/strong-turtles-tan.md delete mode 100644 .changeset/stupid-knives-scream.md delete mode 100644 .changeset/sweet-poets-smell.md delete mode 100644 .changeset/sweet-zebras-deliver.md delete mode 100644 .changeset/swift-radios-remember.md delete mode 100644 .changeset/tall-phones-protect.md delete mode 100644 .changeset/tasty-timers-move.md delete mode 100644 .changeset/ten-comics-own.md delete mode 100644 .changeset/ten-numbers-tease.md delete mode 100644 .changeset/ten-parrots-check.md delete mode 100644 .changeset/thin-pigs-shout.md delete mode 100644 .changeset/tough-houses-talk.md delete mode 100644 .changeset/tricky-mayflies-pull.md delete mode 100644 .changeset/twenty-cheetahs-enjoy.md delete mode 100644 .changeset/twenty-moose-promise.md delete mode 100644 .changeset/two-meals-fix.md delete mode 100644 .changeset/warm-colts-deny.md delete mode 100644 .changeset/weak-coins-sparkle.md delete mode 100644 .changeset/wicked-experts-call.md delete mode 100644 .changeset/witty-socks-invite.md delete mode 100644 .changeset/young-jeans-exercise.md delete mode 100644 docs/pages/plugins/docusaurus/migration-guide.mdx create mode 100644 packages/docusaurus-plugin-typedoc/CHANGELOG_ARCHIVE.md rename packages/typedoc-plugin-markdown/{CHANGELOG_V3..md => CHANGELOG_ARCHIVE..md} (63%) diff --git a/.changeset/afraid-fans-study.md b/.changeset/afraid-fans-study.md deleted file mode 100644 index b77dd3904..000000000 --- a/.changeset/afraid-fans-study.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Changed named anchors to a boolean -- Remove page title from merged readme -- Deprecate hideInPageTOC option diff --git a/.changeset/angry-cars-wash.md b/.changeset/angry-cars-wash.md deleted file mode 100644 index 9fd344892..000000000 --- a/.changeset/angry-cars-wash.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Simplified fileoutput options - replaced kindsWithOwnFile option with an easier to understand `outputFileStrategy` option (see docs) diff --git a/.changeset/big-cooks-lick.md b/.changeset/big-cooks-lick.md deleted file mode 100644 index 665b48e14..000000000 --- a/.changeset/big-cooks-lick.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Mark final default parameters as optional (#396) diff --git a/.changeset/big-ties-dance.md b/.changeset/big-ties-dance.md deleted file mode 100644 index dd0cbec24..000000000 --- a/.changeset/big-ties-dance.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Updated index filenames and Removed indexFileName option diff --git a/.changeset/brave-cows-clean.md b/.changeset/brave-cows-clean.md deleted file mode 100644 index e0983a57c..000000000 --- a/.changeset/brave-cows-clean.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Added `fileExtension` option. diff --git a/.changeset/breezy-avocados-lie.md b/.changeset/breezy-avocados-lie.md deleted file mode 100644 index 21e9595be..000000000 --- a/.changeset/breezy-avocados-lie.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Respect monorepo `readmeFile` configuration (#383) diff --git a/.changeset/bright-pumpkins-tie.md b/.changeset/bright-pumpkins-tie.md deleted file mode 100644 index 46470e215..000000000 --- a/.changeset/bright-pumpkins-tie.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Support disabling numberPrefixParser in docs preset diff --git a/.changeset/brown-mangos-rhyme.md b/.changeset/brown-mangos-rhyme.md deleted file mode 100644 index 32a6d7d06..000000000 --- a/.changeset/brown-mangos-rhyme.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Several ui improvements -- Simplified option names -- Improved documentation -- Fixed and refactored tests diff --git a/.changeset/brown-years-deliver.md b/.changeset/brown-years-deliver.md deleted file mode 100644 index 012b08bef..000000000 --- a/.changeset/brown-years-deliver.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Ensure unique file names for symbols with same name with `flattenOutputFiles` diff --git a/.changeset/chilled-owls-call.md b/.changeset/chilled-owls-call.md deleted file mode 100644 index 14c876aba..000000000 --- a/.changeset/chilled-owls-call.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Expose 'Default value` column to properties table. -- Added sanitizeComments option. -- Navigation structure updates. diff --git a/.changeset/chilled-suits-beg.md b/.changeset/chilled-suits-beg.md deleted file mode 100644 index ad8153065..000000000 --- a/.changeset/chilled-suits-beg.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-frontmatter": major ---- - -- Added `readmeFrontmatter` and `indexFrontmatter` options diff --git a/.changeset/chilly-insects-relax.md b/.changeset/chilly-insects-relax.md deleted file mode 100644 index 694f53ca0..000000000 --- a/.changeset/chilly-insects-relax.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Expose `useMDXFileExt` option. -- Fix hooks being called in incorrect order. diff --git a/.changeset/clean-jobs-fetch.md b/.changeset/clean-jobs-fetch.md deleted file mode 100644 index 6e17130af..000000000 --- a/.changeset/clean-jobs-fetch.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"docusaurus-plugin-typedoc": patch ---- - -- Handle alternative docusaurus `routeBasePath`. diff --git a/.changeset/clean-snakes-cough.md b/.changeset/clean-snakes-cough.md deleted file mode 100644 index 4e42a2acb..000000000 --- a/.changeset/clean-snakes-cough.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-gitlab-wiki-theme": patch ---- - -- Updated sidebar output. diff --git a/.changeset/clever-maps-rescue.md b/.changeset/clever-maps-rescue.md deleted file mode 100644 index 009d64b06..000000000 --- a/.changeset/clever-maps-rescue.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Expose `textContentMappings` to navigation diff --git a/.changeset/cuddly-games-pull.md b/.changeset/cuddly-games-pull.md deleted file mode 100644 index 1eeffc9a0..000000000 --- a/.changeset/cuddly-games-pull.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Run prettier on output files (#398) diff --git a/.changeset/curvy-pillows-guess.md b/.changeset/curvy-pillows-guess.md deleted file mode 100644 index 991f8c8eb..000000000 --- a/.changeset/curvy-pillows-guess.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fixed missing return types -- Added --mergeReadme option -- Tweaked and added specs for reference types diff --git a/.changeset/cyan-islands-tap.md b/.changeset/cyan-islands-tap.md deleted file mode 100644 index 386a13947..000000000 --- a/.changeset/cyan-islands-tap.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Added `flattenOutputFiles` option. -- Lowercased `Object` keyword. diff --git a/.changeset/dirty-walls-serve.md b/.changeset/dirty-walls-serve.md deleted file mode 100644 index de0b0d648..000000000 --- a/.changeset/dirty-walls-serve.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Expose theme hooks similar to default theme. -- Expose TypedDoc media and include syntax. diff --git a/.changeset/dry-pans-perform.md b/.changeset/dry-pans-perform.md deleted file mode 100644 index ecc0d798f..000000000 --- a/.changeset/dry-pans-perform.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Expose `--entryModule` option -- UI updates to header and breadcrumbs -- Prevent MDX parsing symbols as markdown links diff --git a/.changeset/eight-fireants-relate.md b/.changeset/eight-fireants-relate.md deleted file mode 100644 index cb4aea210..000000000 --- a/.changeset/eight-fireants-relate.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -"docusaurus-plugin-typedoc": patch -"typedoc-github-wiki-theme": patch -"typedoc-gitlab-wiki-theme": patch -"typedoc-vitepress-theme": patch -"typedoc-plugin-remark": patch ---- - -- Updated typedoc-plugin-markdown version diff --git a/.changeset/eighty-ladybugs-lick.md b/.changeset/eighty-ladybugs-lick.md deleted file mode 100644 index 2cbc7b729..000000000 --- a/.changeset/eighty-ladybugs-lick.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Added `identifiersAsCodeBlocks`, `propertiesFormat`, `typeDeclarationFormat`, `enumMembersFormat` options. -- Renamed `reflectionsWithOwnFile`=>`kindsWithOwnFile` and `groupByReflections`=>`groupByKinds`. -- General ui tweaks and fixes diff --git a/.changeset/fair-apples-happen.md b/.changeset/fair-apples-happen.md deleted file mode 100644 index 21a5fe306..000000000 --- a/.changeset/fair-apples-happen.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Support loading plugins from docusaurus config diff --git a/.changeset/fair-rice-smoke.md b/.changeset/fair-rice-smoke.md deleted file mode 100644 index 7585c1c19..000000000 --- a/.changeset/fair-rice-smoke.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Expose referenced type links on declaration -- UI fixes diff --git a/.changeset/famous-islands-compare.md b/.changeset/famous-islands-compare.md deleted file mode 100644 index f3a371ce0..000000000 --- a/.changeset/famous-islands-compare.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Prettier 3.0 support diff --git a/.changeset/fast-hotels-rescue.md b/.changeset/fast-hotels-rescue.md deleted file mode 100644 index 0dccf1f75..000000000 --- a/.changeset/fast-hotels-rescue.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-github-wiki-theme": patch ---- - -- Fixed sidebar output diff --git a/.changeset/five-buses-vanish.md b/.changeset/five-buses-vanish.md deleted file mode 100644 index a5aa24dce..000000000 --- a/.changeset/five-buses-vanish.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-github-wiki-theme': major ---- - -- Compatibility fixes for typedoc-plugin-markdown@next diff --git a/.changeset/five-cobras-bake.md b/.changeset/five-cobras-bake.md deleted file mode 100644 index b36e86e59..000000000 --- a/.changeset/five-cobras-bake.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"typedoc-github-wiki-theme": patch -"typedoc-gitlab-wiki-theme": patch -"typedoc-vitepress-theme": patch ---- - -- Updates to typedoc-plugin-markdown internal apis diff --git a/.changeset/five-worms-remain.md b/.changeset/five-worms-remain.md deleted file mode 100644 index 901a66084..000000000 --- a/.changeset/five-worms-remain.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Refactored fileoutput options (renamed symbolsWithOwnFile=>reflectionsWithOwnFile, groupBySymbols=>groupByReflections) diff --git a/.changeset/fluffy-teachers-search.md b/.changeset/fluffy-teachers-search.md deleted file mode 100644 index ce44fb45f..000000000 --- a/.changeset/fluffy-teachers-search.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Added footer partial and footer.text mappings. diff --git a/.changeset/forty-cows-jam.md b/.changeset/forty-cows-jam.md deleted file mode 100644 index 3ba41e5b4..000000000 --- a/.changeset/forty-cows-jam.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fix incorrect heading levels on project reflections diff --git a/.changeset/four-bugs-fail.md b/.changeset/four-bugs-fail.md deleted file mode 100644 index 582726457..000000000 --- a/.changeset/four-bugs-fail.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Removed deprecated options. diff --git a/.changeset/four-fishes-film.md b/.changeset/four-fishes-film.md deleted file mode 100644 index 23e8767eb..000000000 --- a/.changeset/four-fishes-film.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-github-wiki-theme": patch ---- - -- Compatibility fixes diff --git a/.changeset/fresh-forks-poke.md b/.changeset/fresh-forks-poke.md deleted file mode 100644 index f98ea88d4..000000000 --- a/.changeset/fresh-forks-poke.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Load TypeDoc plugins through config diff --git a/.changeset/funny-news-hug.md b/.changeset/funny-news-hug.md deleted file mode 100644 index b334ce3fa..000000000 --- a/.changeset/funny-news-hug.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch -'typedoc-plugin-markdown': patch -'typedoc-vitepress-theme': patch ---- - -- TypeDoc 0.25.0 compatibility fixes diff --git a/.changeset/fuzzy-clocks-whisper.md b/.changeset/fuzzy-clocks-whisper.md deleted file mode 100644 index 0ceb80ff7..000000000 --- a/.changeset/fuzzy-clocks-whisper.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fixed paraterTable style on declarations -- UI updates diff --git a/.changeset/fuzzy-news-decide.md b/.changeset/fuzzy-news-decide.md deleted file mode 100644 index 0cbfe9987..000000000 --- a/.changeset/fuzzy-news-decide.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fix pipes not being escaped correctly with union types in properties table -- Exposed navigation object to renderer -- General UI updates and fixes diff --git a/.changeset/giant-mails-rest.md b/.changeset/giant-mails-rest.md deleted file mode 100644 index 1b8a9530e..000000000 --- a/.changeset/giant-mails-rest.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch -'typedoc-plugin-markdown': patch ---- - -- Export plugin options diff --git a/.changeset/great-phones-fetch.md b/.changeset/great-phones-fetch.md deleted file mode 100644 index 1c2afb2f2..000000000 --- a/.changeset/great-phones-fetch.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Tweaked link behaviour in page header. diff --git a/.changeset/green-lions-walk.md b/.changeset/green-lions-walk.md deleted file mode 100644 index e44ce50cc..000000000 --- a/.changeset/green-lions-walk.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Update ui for @eventProperty tags -- Added `textContentMappings` option diff --git a/.changeset/happy-rats-help.md b/.changeset/happy-rats-help.md deleted file mode 100644 index ce9b53061..000000000 --- a/.changeset/happy-rats-help.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -"docusaurus-plugin-typedoc": patch -"typedoc-github-wiki-theme": patch -"typedoc-gitlab-wiki-theme": patch -"typedoc-vitepress-theme": patch ---- - -- Update core package dependency diff --git a/.changeset/heavy-snakes-press.md b/.changeset/heavy-snakes-press.md deleted file mode 100644 index ab00b28f9..000000000 --- a/.changeset/heavy-snakes-press.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Fixed sidebar ids -- Added option to filter sidebar items (sidebar.filteredIds) -- Added option to pretty output sidebar (sidebar.pretty) diff --git a/.changeset/hip-moose-allow.md b/.changeset/hip-moose-allow.md deleted file mode 100644 index 7da82225f..000000000 --- a/.changeset/hip-moose-allow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-vitepress-theme": patch ---- - -- Expose `docsRoot` option (#540) diff --git a/.changeset/honest-actors-call.md b/.changeset/honest-actors-call.md deleted file mode 100644 index 925b8d3ec..000000000 --- a/.changeset/honest-actors-call.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Fixed navigation structure diff --git a/.changeset/hungry-papayas-punch.md b/.changeset/hungry-papayas-punch.md deleted file mode 100644 index e31ac5438..000000000 --- a/.changeset/hungry-papayas-punch.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Update version diff --git a/.changeset/itchy-seals-count.md b/.changeset/itchy-seals-count.md deleted file mode 100644 index 52f2377ad..000000000 --- a/.changeset/itchy-seals-count.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"docusaurus-plugin-typedoc": patch ---- - -- Correctly handle sidebar ids in Windows (#597). diff --git a/.changeset/khaki-dogs-cheat.md b/.changeset/khaki-dogs-cheat.md deleted file mode 100644 index 76f1fb24e..000000000 --- a/.changeset/khaki-dogs-cheat.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Split out comment summary and tags for signatures diff --git a/.changeset/kind-deers-push.md b/.changeset/kind-deers-push.md deleted file mode 100644 index 991083209..000000000 --- a/.changeset/kind-deers-push.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Support angle brackets, slashes and leading numbers in module names diff --git a/.changeset/kind-monkeys-grow.md b/.changeset/kind-monkeys-grow.md deleted file mode 100644 index 6715996a3..000000000 --- a/.changeset/kind-monkeys-grow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- fix: Remove additional backslash under mdx1 diff --git a/.changeset/large-feet-shout.md b/.changeset/large-feet-shout.md deleted file mode 100644 index 1bf51bed3..000000000 --- a/.changeset/large-feet-shout.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Fix "undefined" custom `@group` headings. diff --git a/.changeset/late-bikes-unite.md b/.changeset/late-bikes-unite.md deleted file mode 100644 index cb1c9d343..000000000 --- a/.changeset/late-bikes-unite.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Escpae curly braces inside comment blocks. diff --git a/.changeset/late-keys-whisper.md b/.changeset/late-keys-whisper.md deleted file mode 100644 index 8f9d27d46..000000000 --- a/.changeset/late-keys-whisper.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fix incorrect heading levels -- Slugify output filenames diff --git a/.changeset/lazy-taxis-camp.md b/.changeset/lazy-taxis-camp.md deleted file mode 100644 index bb5f2836e..000000000 --- a/.changeset/lazy-taxis-camp.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Updated fileoutput for 'packages' entryPointStrategy diff --git a/.changeset/lemon-spiders-taste.md b/.changeset/lemon-spiders-taste.md deleted file mode 100644 index ff354a951..000000000 --- a/.changeset/lemon-spiders-taste.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- fix: Move init logic to contentLoaded lifecycle diff --git a/.changeset/light-steaks-count.md b/.changeset/light-steaks-count.md deleted file mode 100644 index 8585a70ab..000000000 --- a/.changeset/light-steaks-count.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Update header UI diff --git a/.changeset/little-rats-end.md b/.changeset/little-rats-end.md deleted file mode 100644 index 5cc426ce2..000000000 --- a/.changeset/little-rats-end.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Preserve slash in module filenames diff --git a/.changeset/long-crabs-own.md b/.changeset/long-crabs-own.md deleted file mode 100644 index d57a7843c..000000000 --- a/.changeset/long-crabs-own.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Simplified category.yml generation and further refactoring diff --git a/.changeset/long-frogs-divide.md b/.changeset/long-frogs-divide.md deleted file mode 100644 index f8092986e..000000000 --- a/.changeset/long-frogs-divide.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"typedoc-plugin-frontmatter": patch -"typedoc-vitepress-theme": patch -"typedoc-plugin-remark": patch ---- - -- Updated documentation. diff --git a/.changeset/lovely-needles-tap.md b/.changeset/lovely-needles-tap.md deleted file mode 100644 index d75c9fa8d..000000000 --- a/.changeset/lovely-needles-tap.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Remove namespace from module filenames diff --git a/.changeset/lucky-crabs-sin.md b/.changeset/lucky-crabs-sin.md deleted file mode 100644 index 69e90f2e0..000000000 --- a/.changeset/lucky-crabs-sin.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Allow jsx style curly braces in comments. diff --git a/.changeset/lucky-ears-fix.md b/.changeset/lucky-ears-fix.md deleted file mode 100644 index 00fb72054..000000000 --- a/.changeset/lucky-ears-fix.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Updated documentation diff --git a/.changeset/lucky-jokes-switch.md b/.changeset/lucky-jokes-switch.md deleted file mode 100644 index 8c36b8216..000000000 --- a/.changeset/lucky-jokes-switch.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch -'typedoc-github-wiki-theme': patch -'typedoc-gitlab-wiki-theme': patch -'typedoc-plugin-markdown': patch -'typedoc-vitepress-theme': patch ---- - -- Added functionality to skip seperate index page and inject into readme. diff --git a/.changeset/many-bulldogs-give.md b/.changeset/many-bulldogs-give.md deleted file mode 100644 index f01a1c29b..000000000 --- a/.changeset/many-bulldogs-give.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Added `titleTemplate` option to replace hideKindPrefix option -- Fixed incorrect heading title for monorepo packages -- Disable in-built Prettier formatting diff --git a/.changeset/mean-fishes-buy.md b/.changeset/mean-fishes-buy.md deleted file mode 100644 index 94fe33ebf..000000000 --- a/.changeset/mean-fishes-buy.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Expose `mergeReadme` option diff --git a/.changeset/mean-pears-camp.md b/.changeset/mean-pears-camp.md deleted file mode 100644 index 9b8663f77..000000000 --- a/.changeset/mean-pears-camp.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Added symbols to external links. diff --git a/.changeset/metal-forks-exist.md b/.changeset/metal-forks-exist.md deleted file mode 100644 index f3ec74be3..000000000 --- a/.changeset/metal-forks-exist.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"docusaurus-plugin-typedoc": patch ---- - -- Provide exit code on process error (#583) - -Thanks @axel7083 diff --git a/.changeset/mighty-deers-dress.md b/.changeset/mighty-deers-dress.md deleted file mode 100644 index 934424abc..000000000 --- a/.changeset/mighty-deers-dress.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Replace new lines in tables with `
` (#331) diff --git a/.changeset/nasty-starfishes-ring.md b/.changeset/nasty-starfishes-ring.md deleted file mode 100644 index f5e4c6c43..000000000 --- a/.changeset/nasty-starfishes-ring.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Compatibility fixes diff --git a/.changeset/nasty-swans-occur.md b/.changeset/nasty-swans-occur.md deleted file mode 100644 index b52ec4594..000000000 --- a/.changeset/nasty-swans-occur.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Packages output file fixes diff --git a/.changeset/nervous-cherries-cry.md b/.changeset/nervous-cherries-cry.md deleted file mode 100644 index 057777bb1..000000000 --- a/.changeset/nervous-cherries-cry.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Fixed navigation type error (#595) diff --git a/.changeset/new-geckos-grow.md b/.changeset/new-geckos-grow.md deleted file mode 100644 index faea6ca23..000000000 --- a/.changeset/new-geckos-grow.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch -'typedoc-github-wiki-theme': patch -'typedoc-gitlab-wiki-theme': patch -'typedoc-vitepress-theme': patch ---- - -- Allow presets to be overridden. diff --git a/.changeset/nice-goats-dress.md b/.changeset/nice-goats-dress.md deleted file mode 100644 index 67ca791f8..000000000 --- a/.changeset/nice-goats-dress.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fix broken links in packages index. -- Added `navigationModel` option. diff --git a/.changeset/ninety-planets-type.md b/.changeset/ninety-planets-type.md deleted file mode 100644 index c7d1ebda5..000000000 --- a/.changeset/ninety-planets-type.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Updated toc implementation -- Fixed indexPageTitle optio diff --git a/.changeset/odd-kiwis-perform.md b/.changeset/odd-kiwis-perform.md deleted file mode 100644 index a4652937b..000000000 --- a/.changeset/odd-kiwis-perform.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-remark": patch ---- - -- Fix options not being passed to remark plugins diff --git a/.changeset/old-coats-reply.md b/.changeset/old-coats-reply.md deleted file mode 100644 index 73722d7b5..000000000 --- a/.changeset/old-coats-reply.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Fixed omitted object literal default values. diff --git a/.changeset/olive-lies-divide.md b/.changeset/olive-lies-divide.md deleted file mode 100644 index f0fdc9eb6..000000000 --- a/.changeset/olive-lies-divide.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-vitepress-theme': major ---- - -- Initial commit diff --git a/.changeset/olive-pianos-pretend.md b/.changeset/olive-pianos-pretend.md deleted file mode 100644 index 5cc84f54d..000000000 --- a/.changeset/olive-pianos-pretend.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Fix incorrect anchor slugs on urls diff --git a/.changeset/olive-points-hug.md b/.changeset/olive-points-hug.md deleted file mode 100644 index 6bd991de4..000000000 --- a/.changeset/olive-points-hug.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch -'typedoc-plugin-markdown': patch ---- - -- TypdeDoc 0.24 compatibility fixes. diff --git a/.changeset/olive-socks-mate.md b/.changeset/olive-socks-mate.md deleted file mode 100644 index 854d4a78e..000000000 --- a/.changeset/olive-socks-mate.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Exposed `publicPath` option diff --git a/.changeset/olive-suits-lick.md b/.changeset/olive-suits-lick.md deleted file mode 100644 index df968f566..000000000 --- a/.changeset/olive-suits-lick.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"docusaurus-plugin-typedoc": patch ---- - -- Resolve typedoc esm plugins not loading in sync diff --git a/.changeset/orange-teachers-rest.md b/.changeset/orange-teachers-rest.md deleted file mode 100644 index 8a08a6400..000000000 --- a/.changeset/orange-teachers-rest.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"typedoc-vitepress-theme": patch ---- - -- Fix sidebar types -- Rename sidebar.collapse=>sidebar.collapsed diff --git a/.changeset/perfect-ligers-help.md b/.changeset/perfect-ligers-help.md deleted file mode 100644 index 00af5c916..000000000 --- a/.changeset/perfect-ligers-help.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Extract frontmatter logic into seperate TypeDoc plugin diff --git a/.changeset/plenty-bees-worry.md b/.changeset/plenty-bees-worry.md deleted file mode 100644 index 23b319d55..000000000 --- a/.changeset/plenty-bees-worry.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Expose `@experimental` and `@internal` doc flags -- Handle symbols with same name when generating urls -- Expose version to breadcrumbs.home text mapping diff --git a/.changeset/polite-planets-knock.md b/.changeset/polite-planets-knock.md deleted file mode 100644 index a785a1cc5..000000000 --- a/.changeset/polite-planets-knock.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -'typedoc-plugin-markdown': major ---- - -Initial release of next version. In summary includes: - -- Removal of handlebars. -- MDX2 support as standard (#305, #252). -- Exposes additional output file options (#353, #338, #328, #307). -- Several UI improvements. diff --git a/.changeset/polite-ways-hang.md b/.changeset/polite-ways-hang.md deleted file mode 100644 index 6a2b3d9f2..000000000 --- a/.changeset/polite-ways-hang.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Fail docusaurus build when TypeDoc errors - can be overriden with `skipErrorChecking` (#429). -- Enable reading of TypeDoc options from package.json typedocOptions diff --git a/.changeset/poor-gorillas-march.md b/.changeset/poor-gorillas-march.md deleted file mode 100644 index 8e4144079..000000000 --- a/.changeset/poor-gorillas-march.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Remove blockquotes on signature and declarations. -- Minor ui tweaks. diff --git a/.changeset/pre.json b/.changeset/pre.json deleted file mode 100644 index e93c1aea2..000000000 --- a/.changeset/pre.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "mode": "pre", - "tag": "next", - "initialVersions": { - "typedoc-plugin-markdown": "3.15.1", - "typedoc-plugin-remark": "0.0.0", - "typedoc-plugin-frontmatter": "0.0.2", - "docusaurus-plugin-typedoc": "0.18.0", - "typedoc-vitepress-theme": "0.0.0", - "typedoc-github-wiki-theme": "1.0.1", - "typedoc-gitlab-wiki-theme": "1.0.0", - "@devtools/fixtures": "0.0.0", - "@devtools/generate-readmes": "0.0.0", - "@devtools/helpers": "0.0.0", - "@devtools/prebuild-options": "0.0.0", - "@devtools/testing": "0.0.0" - }, - "changesets": [ - "afraid-fans-study", - "angry-cars-wash", - "big-cooks-lick", - "big-ties-dance", - "brave-cows-clean", - "breezy-avocados-lie", - "bright-pumpkins-tie", - "brown-mangos-rhyme", - "brown-years-deliver", - "chilled-owls-call", - "chilled-suits-beg", - "chilly-insects-relax", - "clean-jobs-fetch", - "clean-snakes-cough", - "clever-maps-rescue", - "cuddly-games-pull", - "curvy-pillows-guess", - "cyan-islands-tap", - "dirty-walls-serve", - "dry-pans-perform", - "eight-fireants-relate", - "eighty-ladybugs-lick", - "fair-apples-happen", - "fair-rice-smoke", - "famous-islands-compare", - "fast-hotels-rescue", - "five-buses-vanish", - "five-cobras-bake", - "five-worms-remain", - "fluffy-teachers-search", - "forty-cows-jam", - "four-bugs-fail", - "four-fishes-film", - "fresh-forks-poke", - "funny-news-hug", - "fuzzy-clocks-whisper", - "fuzzy-news-decide", - "giant-mails-rest", - "great-phones-fetch", - "green-lions-walk", - "happy-rats-help", - "heavy-snakes-press", - "hip-moose-allow", - "honest-actors-call", - "hungry-papayas-punch", - "itchy-seals-count", - "khaki-dogs-cheat", - "kind-deers-push", - "kind-monkeys-grow", - "large-feet-shout", - "late-bikes-unite", - "late-keys-whisper", - "lazy-taxis-camp", - "lemon-spiders-taste", - "light-steaks-count", - "little-rats-end", - "long-crabs-own", - "long-frogs-divide", - "lovely-needles-tap", - "lucky-crabs-sin", - "lucky-ears-fix", - "lucky-jokes-switch", - "many-bulldogs-give", - "mean-fishes-buy", - "mean-pears-camp", - "metal-forks-exist", - "mighty-deers-dress", - "nasty-starfishes-ring", - "nasty-swans-occur", - "nervous-cherries-cry", - "new-geckos-grow", - "nice-goats-dress", - "ninety-planets-type", - "odd-kiwis-perform", - "old-coats-reply", - "olive-lies-divide", - "olive-pianos-pretend", - "olive-points-hug", - "olive-socks-mate", - "olive-suits-lick", - "orange-teachers-rest", - "perfect-ligers-help", - "plenty-bees-worry", - "polite-planets-knock", - "polite-ways-hang", - "poor-gorillas-march", - "proud-feet-poke", - "proud-houses-learn", - "proud-houses-tie", - "proud-mugs-pull", - "quiet-birds-taste", - "red-snails-jump", - "rotten-owls-tap", - "selfish-coins-bake", - "selfish-socks-change", - "shaggy-pens-end", - "sharp-timers-brush", - "shiny-ducks-lie", - "silver-chicken-approve", - "six-bottles-rescue", - "six-coats-carry", - "sixty-hornets-argue", - "slow-worms-provide", - "small-kangaroos-kick", - "smart-spoons-kneel", - "smooth-carrots-relate", - "spicy-beans-leave", - "spicy-students-fetch", - "stale-coats-perform", - "stale-suns-explain", - "strong-toys-move", - "strong-turtles-tan", - "stupid-knives-scream", - "sweet-poets-smell", - "sweet-zebras-deliver", - "swift-radios-remember", - "tall-phones-protect", - "tasty-timers-move", - "ten-comics-own", - "ten-numbers-tease", - "ten-parrots-check", - "thin-pigs-shout", - "tough-houses-talk", - "tricky-mayflies-pull", - "twenty-cheetahs-enjoy", - "twenty-moose-promise", - "two-meals-fix", - "warm-colts-deny", - "weak-coins-sparkle", - "wicked-experts-call", - "witty-socks-invite", - "young-jeans-exercise" - ] -} diff --git a/.changeset/proud-feet-poke.md b/.changeset/proud-feet-poke.md deleted file mode 100644 index eae25ed9a..000000000 --- a/.changeset/proud-feet-poke.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Replace category.yml with readable dir names diff --git a/.changeset/proud-houses-learn.md b/.changeset/proud-houses-learn.md deleted file mode 100644 index e53a7407d..000000000 --- a/.changeset/proud-houses-learn.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Updated breadcrumbs UI diff --git a/.changeset/proud-houses-tie.md b/.changeset/proud-houses-tie.md deleted file mode 100644 index e79576754..000000000 --- a/.changeset/proud-houses-tie.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Correctly resolve packge readme urls from member pages (#483) -- Prevent trigger of reversed link syntax rule on index access types (#484) diff --git a/.changeset/proud-mugs-pull.md b/.changeset/proud-mugs-pull.md deleted file mode 100644 index bcb6776da..000000000 --- a/.changeset/proud-mugs-pull.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -'typedoc-plugin-markdown': minor ---- - -- Expose Frontmatter options (#384), (#360) -- Convert comment `@tags` to headings -- Export files following module structure as default -- UI improvemements diff --git a/.changeset/quiet-birds-taste.md b/.changeset/quiet-birds-taste.md deleted file mode 100644 index 1d4f5062e..000000000 --- a/.changeset/quiet-birds-taste.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Updated sidebar implementation (see readme) -- Removed frontmatter -- Fixed double escaped angle bracket diff --git a/.changeset/red-snails-jump.md b/.changeset/red-snails-jump.md deleted file mode 100644 index 8c1658649..000000000 --- a/.changeset/red-snails-jump.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Added `numberPrefixOutput` and `hideKindPrefix` options -- Support `includeVersion` -- Decoupled renderer methods -- Further refactoring and fixes diff --git a/.changeset/rotten-owls-tap.md b/.changeset/rotten-owls-tap.md deleted file mode 100644 index 31e1466a0..000000000 --- a/.changeset/rotten-owls-tap.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fix fileoutput for 'packages' entryPointStrategy -- Tweaked header/breadcrumbs diff --git a/.changeset/selfish-coins-bake.md b/.changeset/selfish-coins-bake.md deleted file mode 100644 index 0aa2958a9..000000000 --- a/.changeset/selfish-coins-bake.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fix optional declarations in code blocks -- Improve hierarchy output diff --git a/.changeset/selfish-socks-change.md b/.changeset/selfish-socks-change.md deleted file mode 100644 index a9ad66815..000000000 --- a/.changeset/selfish-socks-change.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Fix sidebar child sidebar items diff --git a/.changeset/shaggy-pens-end.md b/.changeset/shaggy-pens-end.md deleted file mode 100644 index 44cab467a..000000000 --- a/.changeset/shaggy-pens-end.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Escape angle brackets in comment blocks unless inside backticks (#276) diff --git a/.changeset/sharp-timers-brush.md b/.changeset/sharp-timers-brush.md deleted file mode 100644 index 7c79b0119..000000000 --- a/.changeset/sharp-timers-brush.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Expose `groupBySymbols` option diff --git a/.changeset/shiny-ducks-lie.md b/.changeset/shiny-ducks-lie.md deleted file mode 100644 index ec1931bcf..000000000 --- a/.changeset/shiny-ducks-lie.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Code refactoring diff --git a/.changeset/silver-chicken-approve.md b/.changeset/silver-chicken-approve.md deleted file mode 100644 index 160306731..000000000 --- a/.changeset/silver-chicken-approve.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"typedoc-github-wiki-theme": patch -"typedoc-gitlab-wiki-theme": patch -"typedoc-vitepress-theme": patch ---- - -- API updates from typedoc-plugin-markdown diff --git a/.changeset/six-bottles-rescue.md b/.changeset/six-bottles-rescue.md deleted file mode 100644 index 3bef9f6c1..000000000 --- a/.changeset/six-bottles-rescue.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Discover prettier config files diff --git a/.changeset/six-coats-carry.md b/.changeset/six-coats-carry.md deleted file mode 100644 index c3d9818fa..000000000 --- a/.changeset/six-coats-carry.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-remark": patch ---- - -- Enable frontmatter and GFM compatibility diff --git a/.changeset/sixty-hornets-argue.md b/.changeset/sixty-hornets-argue.md deleted file mode 100644 index 4d6762b5b..000000000 --- a/.changeset/sixty-hornets-argue.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Support Docusaurus 3 diff --git a/.changeset/slow-worms-provide.md b/.changeset/slow-worms-provide.md deleted file mode 100644 index 8237d19bf..000000000 --- a/.changeset/slow-worms-provide.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- remove header readme labell diff --git a/.changeset/small-kangaroos-kick.md b/.changeset/small-kangaroos-kick.md deleted file mode 100644 index f059c2603..000000000 --- a/.changeset/small-kangaroos-kick.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -"docusaurus-plugin-typedoc": patch -"typedoc-github-wiki-theme": patch -"typedoc-gitlab-wiki-theme": patch -"typedoc-vitepress-theme": patch ---- - -- typedoc-plugin-markdown compaibility fixes: diff --git a/.changeset/smart-spoons-kneel.md b/.changeset/smart-spoons-kneel.md deleted file mode 100644 index 3535304fd..000000000 --- a/.changeset/smart-spoons-kneel.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- UI improvements -- Enable anchor to items inside table diff --git a/.changeset/smooth-carrots-relate.md b/.changeset/smooth-carrots-relate.md deleted file mode 100644 index d4bf3bc35..000000000 --- a/.changeset/smooth-carrots-relate.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Ignore seperate module index when `entryModule` is defined. diff --git a/.changeset/spicy-beans-leave.md b/.changeset/spicy-beans-leave.md deleted file mode 100644 index 4af05e678..000000000 --- a/.changeset/spicy-beans-leave.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-remark": major ---- - -- Updated version diff --git a/.changeset/spicy-students-fetch.md b/.changeset/spicy-students-fetch.md deleted file mode 100644 index 33029f778..000000000 --- a/.changeset/spicy-students-fetch.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Updated default `--indexPageTitle` to {projectName} -- Renamed `--titleTemplate` -> `--memberPageTitle` diff --git a/.changeset/stale-coats-perform.md b/.changeset/stale-coats-perform.md deleted file mode 100644 index 86a3a599e..000000000 --- a/.changeset/stale-coats-perform.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-vitepress-theme": patch ---- - -- Exposed additional sidebar options diff --git a/.changeset/stale-suns-explain.md b/.changeset/stale-suns-explain.md deleted file mode 100644 index 1fc08e406..000000000 --- a/.changeset/stale-suns-explain.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Added ability to easily override templates for custom theming. -- Correct typo in the option `identifiersAsCodeBlocks`. -- UI fixes. -- Expose docs for intersection type literals. -- Allow HTML inside code blocks. diff --git a/.changeset/strong-toys-move.md b/.changeset/strong-toys-move.md deleted file mode 100644 index cf97f05e1..000000000 --- a/.changeset/strong-toys-move.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Fixed `mergeReadme` for packages entryPointStrategy diff --git a/.changeset/strong-turtles-tan.md b/.changeset/strong-turtles-tan.md deleted file mode 100644 index 27a443475..000000000 --- a/.changeset/strong-turtles-tan.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Fixed `publicPath` implemention. diff --git a/.changeset/stupid-knives-scream.md b/.changeset/stupid-knives-scream.md deleted file mode 100644 index 547109661..000000000 --- a/.changeset/stupid-knives-scream.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Handle Docusaurus broken links around type arguments diff --git a/.changeset/sweet-poets-smell.md b/.changeset/sweet-poets-smell.md deleted file mode 100644 index 8581cb31a..000000000 --- a/.changeset/sweet-poets-smell.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Handle sidebar ids with number prefixes diff --git a/.changeset/sweet-zebras-deliver.md b/.changeset/sweet-zebras-deliver.md deleted file mode 100644 index 704043456..000000000 --- a/.changeset/sweet-zebras-deliver.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Strikethough members marked as deprecated -- Expose returned declarations for reference types diff --git a/.changeset/swift-radios-remember.md b/.changeset/swift-radios-remember.md deleted file mode 100644 index c535bc300..000000000 --- a/.changeset/swift-radios-remember.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Version bump diff --git a/.changeset/tall-phones-protect.md b/.changeset/tall-phones-protect.md deleted file mode 100644 index 005e4dc05..000000000 --- a/.changeset/tall-phones-protect.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Omit number prefixes from index files diff --git a/.changeset/tasty-timers-move.md b/.changeset/tasty-timers-move.md deleted file mode 100644 index e9309072c..000000000 --- a/.changeset/tasty-timers-move.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-gitlab-wiki-theme': major ---- - -- Compatibility with typedoc-plugin-markdown@next diff --git a/.changeset/ten-comics-own.md b/.changeset/ten-comics-own.md deleted file mode 100644 index 9ae3fc358..000000000 --- a/.changeset/ten-comics-own.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Expose `membersWithOwnFile`, `preserveMarkup` and `excludeScopesInPaths` options. -- Improve signature ui. -- Exposed additional file options to packages -- Fix index table format for packages. diff --git a/.changeset/ten-numbers-tease.md b/.changeset/ten-numbers-tease.md deleted file mode 100644 index aae5b7539..000000000 --- a/.changeset/ten-numbers-tease.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Simplify frontmatter implementation diff --git a/.changeset/ten-parrots-check.md b/.changeset/ten-parrots-check.md deleted file mode 100644 index a467baec5..000000000 --- a/.changeset/ten-parrots-check.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Use correct path separator in sidebar urls (#489) diff --git a/.changeset/thin-pigs-shout.md b/.changeset/thin-pigs-shout.md deleted file mode 100644 index 2827e99ae..000000000 --- a/.changeset/thin-pigs-shout.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Escape curly braces in type declarations diff --git a/.changeset/tough-houses-talk.md b/.changeset/tough-houses-talk.md deleted file mode 100644 index 4b5b928e4..000000000 --- a/.changeset/tough-houses-talk.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- UI tweaks to properties display diff --git a/.changeset/tricky-mayflies-pull.md b/.changeset/tricky-mayflies-pull.md deleted file mode 100644 index 71fe971a2..000000000 --- a/.changeset/tricky-mayflies-pull.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Exposed function keyword to code blocks. -- Fixed some incorrect navigation structures. diff --git a/.changeset/twenty-cheetahs-enjoy.md b/.changeset/twenty-cheetahs-enjoy.md deleted file mode 100644 index f5b0b1e67..000000000 --- a/.changeset/twenty-cheetahs-enjoy.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-vitepress-theme": patch ---- - -- Replace `/index.md` with `/` on sidebar root paths diff --git a/.changeset/twenty-moose-promise.md b/.changeset/twenty-moose-promise.md deleted file mode 100644 index 62df69191..000000000 --- a/.changeset/twenty-moose-promise.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': major ---- - -- Compatibility updates for typedoc-plugin-markdown diff --git a/.changeset/two-meals-fix.md b/.changeset/two-meals-fix.md deleted file mode 100644 index bb1c0d464..000000000 --- a/.changeset/two-meals-fix.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Fix params being incorrectly escaped in list format. -- Removed generator in footer. -- Fix typing of the defineTheme method. diff --git a/.changeset/warm-colts-deny.md b/.changeset/warm-colts-deny.md deleted file mode 100644 index 7a23c316a..000000000 --- a/.changeset/warm-colts-deny.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Expose `expandParameters` option. diff --git a/.changeset/weak-coins-sparkle.md b/.changeset/weak-coins-sparkle.md deleted file mode 100644 index 00fb72054..000000000 --- a/.changeset/weak-coins-sparkle.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -"typedoc-plugin-markdown": patch ---- - -- Updated documentation diff --git a/.changeset/wicked-experts-call.md b/.changeset/wicked-experts-call.md deleted file mode 100644 index 5617dcd85..000000000 --- a/.changeset/wicked-experts-call.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Generate packages.md even if groups used diff --git a/.changeset/witty-socks-invite.md b/.changeset/witty-socks-invite.md deleted file mode 100644 index 8361a6a35..000000000 --- a/.changeset/witty-socks-invite.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'docusaurus-plugin-typedoc': patch ---- - -- Updated readme diff --git a/.changeset/young-jeans-exercise.md b/.changeset/young-jeans-exercise.md deleted file mode 100644 index 65a0e05ed..000000000 --- a/.changeset/young-jeans-exercise.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'typedoc-plugin-markdown': patch ---- - -- Enable outputFileStrategy in "packages" mode diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 983472465..2a8baa970 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,7 +2,7 @@ name: Release on: push: branches: - - next + - main concurrency: ${{ github.workflow }}-${{ github.ref }} jobs: release: diff --git a/README.md b/README.md index 81e6f328c..eff8ad4b8 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ This project is a collection of packages designed for generate TypeScript API do ## Packages -| Package | Badges | -| :---| :---| -[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown?label=↓) | -[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-frontmatter) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter?label=↓) | -[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-remark.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-remark) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark?label=↓) | -[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme?label=↓) | -[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme?label=↓) | -[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme?label=↓) | -[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc?label=↓) | +| Package | Version | Downloads | Changelog +| :---| :---| :---| :---| +[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) | typedoc-plugin-markdown Downloads | [Changelog](./packages/typedoc-plugin-markdown/CHANGELOG.md) | +[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-frontmatter) | typedoc-plugin-frontmatter Downloads | [Changelog](./packages/typedoc-plugin-frontmatter/CHANGELOG.md) | +[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-remark.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-remark) | typedoc-plugin-remark Downloads | [Changelog](./packages/typedoc-plugin-remark/CHANGELOG.md) | +[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) | typedoc-github-wiki-theme Downloads | [Changelog](./packages/typedoc-github-wiki-theme/CHANGELOG.md) | +[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) | typedoc-gitlab-wiki-theme Downloads | [Changelog](./packages/typedoc-gitlab-wiki-theme/CHANGELOG.md) | +[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) | typedoc-vitepress-theme Downloads | [Changelog](./packages/typedoc-vitepress-theme/CHANGELOG.md) | +[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) | docusaurus-plugin-typedoc Downloads | [Changelog](./packages/docusaurus-plugin-typedoc/CHANGELOG.md) | ## Documentation diff --git a/devtools/examples/README.md b/devtools/examples/README.md index c2c1f8a17..2ff56ea4f 100644 --- a/devtools/examples/README.md +++ b/devtools/examples/README.md @@ -3,4 +3,4 @@ These folder is intended for internal dev purposes. For plugin examples please visit: - https://github.com/typedoc2md/typedoc-plugin-markdown-examples -- https://github.com/tgreyuk/typedoc-vitepress-theme-example +- https://github.com/typedoc2md/typedoc-vitepress-theme-example diff --git a/devtools/scripts/generate-readmes.ts b/devtools/scripts/generate-readmes.ts index 7981d879e..41296558e 100755 --- a/devtools/scripts/generate-readmes.ts +++ b/devtools/scripts/generate-readmes.ts @@ -56,18 +56,19 @@ function writeRepositoryReadme(packages: any) { readme.push('## Packages'); const headers: string[] = []; - headers.push('| Package | Badges | '); - headers.push('| :---| :---|'); + headers.push('| Package | Version | Downloads | Changelog '); + headers.push('| :---| :---| :---| :---|'); const table: string[] = []; const rows = packages.map((packageItem) => { const badges = [ `[![npm](https://img.shields.io/npm/v/${packageItem.name}.svg?logo=npm)](https://www.npmjs.com/package/${packageItem.name})`, - `![Downloads](https://img.shields.io/npm/dm/${packageItem.name}?label=↓)`, + `${packageItem.name} Downloads`, ]; return ( [ `[${packageItem.name}](./packages/${packageItem.name}#readme)`, - badges.join(' '), + ...badges, + `[Changelog](./packages/${packageItem.name}/CHANGELOG.md)`, ].join(' | ') + ' | ' ); }); diff --git a/docs/pages/plugins/docusaurus/_meta.js b/docs/pages/plugins/docusaurus/_meta.js index 2a9576c45..ad9a6eb8d 100644 --- a/docs/pages/plugins/docusaurus/_meta.js +++ b/docs/pages/plugins/docusaurus/_meta.js @@ -1,16 +1,7 @@ export default { 'quick-start': '', options: '', - '-- Guide': { - type: 'separator', - title: 'Guide', - }, sidebar: '', 'multi-instance': '', 'watch-mode': '', - '-- Support': { - type: 'separator', - title: 'Support', - }, - 'migration-guide': 'Migrating from 0.x.x', }; diff --git a/docs/pages/plugins/docusaurus/migration-guide.mdx b/docs/pages/plugins/docusaurus/migration-guide.mdx deleted file mode 100644 index 7b35aa0ff..000000000 --- a/docs/pages/plugins/docusaurus/migration-guide.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# 🚀 Migrating from 0.x.x - -## Sidebar - -- A manual sidebar file should be referenced in `sidebars.js` rather than autogenerated configuration as previouslly recommended. See [sidebar guide](/plugins/docusaurus/guide/sidebar). -- With the updated configuration the existing sidebar options `position` and `categoryLabel` are no longer relevant. - -## Options - -- `includeExtension` has been removed as this behaviour is now the default. -- `frontmatter` option has been removed. Please use `typedoc-plugin-frontmatter`. diff --git a/packages/docusaurus-plugin-typedoc/CHANGELOG.md b/packages/docusaurus-plugin-typedoc/CHANGELOG.md index 02078bc47..ace0de3a1 100644 --- a/packages/docusaurus-plugin-typedoc/CHANGELOG.md +++ b/packages/docusaurus-plugin-typedoc/CHANGELOG.md @@ -1,423 +1,34 @@ # Changelog -## 1.0.0-next.30 +## 1.0.0 (2024-05-03) -### Patch Changes +> v1 is a major release that includes a number of improvements. -- Correctly handle sidebar ids in Windows ([#597](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/597)). - -## 1.0.0-next.29 - -### Patch Changes - -- typedoc-plugin-markdown compaibility fixes: - -## 1.0.0-next.28 (2024-03-21) - -### Patch Changes - -- Provide exit code on process error ([#583](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/583)) - -Thanks @axel7083 - -## 1.0.0-next.27 (2024-01-31) - -### Patch Changes - -- Handle alternative docusaurus `routeBasePath`. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.45 - -## 1.0.0-next.26 (2024-01-30) - -### Patch Changes - -- Update core package dependency -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.44 - -## 1.0.0-next.25 (2023-01-07) - -### Patch Changes - -- Updated typedoc-plugin-markdown version -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.40 - -## 1.0.0-next.24 - -### Patch Changes - -- Resolve typedoc esm plugins not loading in sync -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.39 - -## 1.0.0-next.23 - -### Patch Changes - -- Handle Docusaurus broken links around type arguments -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.30 - -## 1.0.0-next.22 (2023-11-18) - -### Patch Changes - -- Fix sidebar child sidebar items -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.28 - -## 1.0.0-next.21 (2023-11-07) - -### Patch Changes - -- Support disabling numberPrefixParser in docs preset -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.26 - -## 1.0.0-next.20 (2023-11-05) - -### Patch Changes - -- Handle sidebar ids with number prefixes - -## 1.0.0-next.19 (2023-11-01) - -### Patch Changes - -- Remove additional backslash under mdx1 -- Use correct path separator in sidebar urls ([#489](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/489)) - -## 1.0.0-next.18 (2023-10-21) - -### Patch Changes - -- Support Docusaurus 3 -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.24 - -## 1.0.0-next.17 (2023-09-26) - -### Patch Changes - -- Fixed sidebar ids -- Added option to filter sidebar items (sidebar.filteredIds) -- Added option to pretty output sidebar (sidebar.pretty) -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.22 - -## 1.0.0-next.16 (2023-09-25) - -### Patch Changes - -- Updated sidebar implementation (see readme) -- Removed frontmatter -- Fixed double escaped angle bracket -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.21 - -## 1.0.0-next.15 (2023-08-27) - -### Patch Changes - -- TypeDoc 0.25.0 compatibility fixes -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.19 - -## 1.0.0-next.14 (2023-08-10) - -### Patch Changes - -- Load TypeDoc plugins through config -- fix: Move init logic to contentLoaded lifecycle -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.18 - -## 1.0.0-next.13 (2023-06-12) - -### Patch Changes - -- Export plugin options -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.14 - -## 1.0.0-next.12 (2023-05-26) - -### Patch Changes - -- Updated readme - -## 1.0.0-next.11 (2023-05-26) - -### Patch Changes - -- Allow presets to be overridden. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.13 - -## 1.0.0-next.10 (2023-05-17) - -### Patch Changes - -- Added functionality to skip seperate index page and inject into readme. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.12 - -## 1.0.0-next.9 (2023-05-13) - -### Patch Changes - -- Updated fileoutput for 'packages' entryPointStrategy -- Fail docusaurus build when TypeDoc errors - can be overriden with `skipErrorChecking` ([#429](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/429)). -- Enable reading of TypeDoc options from package.json typedocOptions -- Replace category.yml with readable dir names -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.11 - -## 1.0.0-next.8 - -### Patch Changes - -- Simplified category.yml generation and further refactoring -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.9 - -## 1.0.0-next.7 - -### Patch Changes - -- Code refactoring - -## 1.0.0-next.6 - -### Patch Changes - -- Support loading plugins from docusaurus config -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.8 - -## 1.0.0-next.5 - -### Patch Changes - -- Version bump -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.6 - -## 1.0.0-next.4 - -### Patch Changes - -- Simplify frontmatter implementation -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.5 - -## 1.0.0-next.3 - -### Patch Changes - -- TypdeDoc 0.24 compatibility fixes. - -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.4 - -## 1.0.0-next.2 - -### Patch Changes - -- Update version -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.2 - -## 1.0.0-next.1 - -### Patch Changes - -- Compatibility fixes -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.1 - -## 1.0.0-next.0 - -### Major Changes - -- Compatibility updates for typedoc-plugin-markdown +### Architectural Changes -### Patch Changes +- typedoc-plugin-markdown must be updated to V4. +- `category.yml` files are no longer written. +- Frontmatter is no longer included by default. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.0 +### Breaking Changes -## [0.17.6](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.5...docusaurus-plugin-typedoc@0.17.6) (2022-06-27) +#### Sidebar Configuration -**Note:** Version bump only for package docusaurus-plugin-typedoc +- A manual sidebar file should be referenced in `sidebars.js` rather than autogenerated configuration as previously recommended. See [sidebar guide](/plugins/docusaurus/guide/sidebar). -## [0.17.5](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.4...docusaurus-plugin-typedoc@0.17.5) (2022-05-10) +#### Options Changes -### Bug Fixes - -- added sidebar.autoConfiguration option ([f873b32](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/f873b32f2342b74c68f0bda8e7661b265b4d93ab)) -- Removed index slug ([3667eb5](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/3667eb59035b422b4f569f76635cfe682fbac5ac)) - -## [0.17.4](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.3...docusaurus-plugin-typedoc@0.17.4) (2022-04-21) - -- Removed indexSlug - -## [0.17.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.2...docusaurus-plugin-typedoc@0.17.3) (2022-04-09) - -**Note:** Version bump only for package docusaurus-plugin-typedoc - -## [0.17.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.1...docusaurus-plugin-typedoc@0.17.2) (2022-03-05) - -- Allow option `cleanOutputDir` ([#296](https://github.com/typedoc2md/typedoc-plugin-markdown/pull/296)) - -## [0.17.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.0...docusaurus-plugin-typedoc@0.17.2) (2022-03-05) - -**Note:** Version bump only for package docusaurus-plugin-typedoc - -# [0.17.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.9...docusaurus-plugin-typedoc@0.17.0) (2022-02-18) - -### Features - -- Added ability to pass in additional global Frontmatter options ([55cc7e0](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/55cc7e0f1c373e11438e090f537d12340d501c58)) -- Added new includeExtension option ([#293](https://github.com/typedoc2md/typedoc-plugin-markdown/pull/293)) - -## [0.16.9](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.8...docusaurus-plugin-typedoc@0.16.9) (2022-02-05) - -### Bug Fixes - -- resolve broken links issue ([ec2610e](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/ec2610ef47b026ff54ef9a98c17aec53883a2d50)) - -## [0.16.8](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.7...docusaurus-plugin-typedoc@0.16.8) (2022-02-02) - -### Bug Fixes - -- remove removing of md suffix ([e451a3d](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/e451a3d01874a65c1520f7091ee2945c02257f79)) - -## [0.16.7](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.6...docusaurus-plugin-typedoc@0.16.7) (2022-01-09) - -### Bug Fixes - -- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45)) -- Use TypeDoc 'defineTheme' to register docusaurus theme ([ab5878d](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/ab5878d35c4e95297782b1c7fde030f96f70df1a)) - -## [0.16.6](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.5...docusaurus-plugin-typedoc@0.16.6) (2021-12-07) - -### Bug Fixes - -- move plugin definition to loadContent() lifecycle ([#271](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/271)) ([54104a8](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/54104a82b1e46d5ee0cca3bdf506874cd5fe41df)) - -## [0.16.5](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.4...docusaurus-plugin-typedoc@0.16.5) (2021-11-29) - -### Bug Fixes - -- define slug as '/' when out = '.' ([f22f049](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/f22f04952ebc7733489d3dac530aa7acbe84218d)) - -## [0.16.4](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.3...docusaurus-plugin-typedoc@0.16.4) (2021-11-12) - -### Bug Fixes - -- Prevent watch mode crashing ([950d872](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/950d8727fd43051edf6216d96c4232e3ed1287e6)) - -## [0.16.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.2...docusaurus-plugin-typedoc@0.16.3) (2021-09-21) - -### Bug Fixes - -- cleanup pre-render steps ([9566a9c](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/9566a9c136fbd8aaa0974219a09076b636bf1cb5)) - -## [0.16.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.1...docusaurus-plugin-typedoc@0.16.2) (2021-09-18) +- `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 -- remove manual sidebar generation and fix pre-render docs order ([#251](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/251)) ([eb21cb4](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/eb21cb439e746127ec0ffa128f67f0ee2e6b4767)) - -## [0.16.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.0...docusaurus-plugin-typedoc@0.16.1) (2021-09-17) - -### Bug Fixes - -- fix relative urls to index slug ([900e727](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/900e7276c5353b9a6fc2cd162cfe7408c070cc63)) - -# [0.16.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.3...docusaurus-plugin-typedoc@0.16.0) (2021-09-14) - -### Features - -- TypeDoc 0.22 compatibility fixes ([#249](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353)) - -## [0.15.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.2...docusaurus-plugin-typedoc@0.15.3) (2021-07-20) - -### Bug Fixes - -- Generate namespaces into own directory to fix sidebar category ([bd7669e](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/bd7669efc7eb43a91567451f3be17b5651f82a78)) -- Handle windows back-slash in slug ([#245](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/245)) ([9178963](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/917896393359426077e36149ab50b07252aafa49)) - -## [0.15.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.1...docusaurus-plugin-typedoc@0.15.2) (2021-07-12) - -### Bug Fixes - -- Handle TypeDoc 0.21.3 options breaking change ([b3be4f8](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/b3be4f807e57de7720663363b967633a57523d3e)) - -## [0.15.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.0...docusaurus-plugin-typedoc@0.15.1) (2021-07-03) - -### Bug Fixes - -- Fix generated sidebar dirName ([49d3a01](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/49d3a0185b9e7176f85a6de3318c9e5a0649869c)) - -# [0.15.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.14.2...docusaurus-plugin-typedoc@0.15.0) (2021-06-18) - -### Features - -- TypeDoc 0.21 compatibility ([9659567](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/9659567e439a20de57aaeeddc8abf09f787a8a97)) - -## [0.14.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.14.1...docusaurus-plugin-typedoc@0.14.2) (2021-06-01) - -### Bug Fixes - -- Use front-matter title to fix escapes angle brackets ([c5bc964](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/c5bc9645b4de81c2050271c0d85583d9bfbac531)) - -## [0.14.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.14.0...docusaurus-plugin-typedoc@0.14.1) (2021-05-06) - -### Bug Fixes - -- Fix manual sidebar backward compatibility ([#224](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/224)) ([dc873d4](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/dc873d430ff29307e29abc81f115b5033a89ab51)) - -# [0.14.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.13.0...docusaurus-plugin-typedoc@0.14.0) (2021-05-05) - -### Features - -- Replace manual sidebar logic with autogenerated sidebars ([#217](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/217)) ([a2002ca](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/a2002cabe487180f802249e9378b7b50e01fee76)) -- Update sidebar label for 'Exports' ([#223](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/223)) ([a96aa4e](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/a96aa4eb644b027ab501e9e2f998e4853a5ef18e)) - -# [0.13.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.12.1...docusaurus-plugin-typedoc@0.13.0) (2021-04-28) - -### Bug Fixes - -- Consolidate options after TypeDoc option readers ([#214](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/214)) ([14b24e4](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/14b24e4f81ec2a937985ab8317a23010c9e84419)) - -### Features - -- Update heading logic as per 'frontmatter-less' titles in alpha.73 ([62cf0d1](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/62cf0d1626289de168b71982fdbd694f0e17d21b)) - -# [0.12.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.11.0...docusaurus-plugin-typedoc@0.12.0) (2021-03-22) - -### Features - -- Remove side TOC on index page ([07ed973](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/07ed9738a1abf136e523fcd353b6a97691317c4c)) - -# [0.11.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.9.1...docusaurus-plugin-typedoc@0.11.0) (2021-03-08) - -### Bug Fixes - -- Allow plugins to be loaded with options file ([#200](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/200)) ([3a8a891](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/3a8a89136d27d68f56a399030fe6580ca4c6d36b)) - -# [0.10.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.9.1...docusaurus-plugin-typedoc@0.10.0) (2021-02-21) - -### Features - -- Support for TypeDoc `--watch` option ([#193](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/193)). ([6ed7d97](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/6ed7d97db3ead39bdea7f5fb829ac8dc60272e49)) - -# 0.9.0 (2021-01-29) +- 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)). -### Features +--- -- Support for `custom_edit_url` ([#190](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/190)) +Earlier changelog entries can be found in `CHANGELOG_ARCHIVE.md`. diff --git a/packages/docusaurus-plugin-typedoc/CHANGELOG_ARCHIVE.md b/packages/docusaurus-plugin-typedoc/CHANGELOG_ARCHIVE.md new file mode 100644 index 000000000..9739e8842 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/CHANGELOG_ARCHIVE.md @@ -0,0 +1,174 @@ +# Changelog (Archive) + +## [0.17.6](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.5...docusaurus-plugin-typedoc@0.17.6) (2022-06-27) + +**Note:** Version bump only for package docusaurus-plugin-typedoc + +## [0.17.5](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.4...docusaurus-plugin-typedoc@0.17.5) (2022-05-10) + +### Bug Fixes + +- added sidebar.autoConfiguration option ([f873b32](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/f873b32f2342b74c68f0bda8e7661b265b4d93ab)) +- Removed index slug ([3667eb5](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/3667eb59035b422b4f569f76635cfe682fbac5ac)) + +## [0.17.4](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.3...docusaurus-plugin-typedoc@0.17.4) (2022-04-21) + +- Removed indexSlug + +## [0.17.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.2...docusaurus-plugin-typedoc@0.17.3) (2022-04-09) + +**Note:** Version bump only for package docusaurus-plugin-typedoc + +## [0.17.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.1...docusaurus-plugin-typedoc@0.17.2) (2022-03-05) + +- Allow option `cleanOutputDir` ([#296](https://github.com/typedoc2md/typedoc-plugin-markdown/pull/296)) + +## [0.17.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.17.0...docusaurus-plugin-typedoc@0.17.2) (2022-03-05) + +**Note:** Version bump only for package docusaurus-plugin-typedoc + +# [0.17.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.9...docusaurus-plugin-typedoc@0.17.0) (2022-02-18) + +### Features + +- Added ability to pass in additional global Frontmatter options ([55cc7e0](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/55cc7e0f1c373e11438e090f537d12340d501c58)) +- Added new includeExtension option ([#293](https://github.com/typedoc2md/typedoc-plugin-markdown/pull/293)) + +## [0.16.9](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.8...docusaurus-plugin-typedoc@0.16.9) (2022-02-05) + +### Bug Fixes + +- resolve broken links issue ([ec2610e](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/ec2610ef47b026ff54ef9a98c17aec53883a2d50)) + +## [0.16.8](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.7...docusaurus-plugin-typedoc@0.16.8) (2022-02-02) + +### Bug Fixes + +- remove removing of md suffix ([e451a3d](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/e451a3d01874a65c1520f7091ee2945c02257f79)) + +## [0.16.7](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.6...docusaurus-plugin-typedoc@0.16.7) (2022-01-09) + +### Bug Fixes + +- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45)) +- Use TypeDoc 'defineTheme' to register docusaurus theme ([ab5878d](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/ab5878d35c4e95297782b1c7fde030f96f70df1a)) + +## [0.16.6](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.5...docusaurus-plugin-typedoc@0.16.6) (2021-12-07) + +### Bug Fixes + +- move plugin definition to loadContent() lifecycle ([#271](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/271)) ([54104a8](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/54104a82b1e46d5ee0cca3bdf506874cd5fe41df)) + +## [0.16.5](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.4...docusaurus-plugin-typedoc@0.16.5) (2021-11-29) + +### Bug Fixes + +- define slug as '/' when out = '.' ([f22f049](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/f22f04952ebc7733489d3dac530aa7acbe84218d)) + +## [0.16.4](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.3...docusaurus-plugin-typedoc@0.16.4) (2021-11-12) + +### Bug Fixes + +- Prevent watch mode crashing ([950d872](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/950d8727fd43051edf6216d96c4232e3ed1287e6)) + +## [0.16.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.2...docusaurus-plugin-typedoc@0.16.3) (2021-09-21) + +### Bug Fixes + +- cleanup pre-render steps ([9566a9c](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/9566a9c136fbd8aaa0974219a09076b636bf1cb5)) + +## [0.16.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.1...docusaurus-plugin-typedoc@0.16.2) (2021-09-18) + +### Bug Fixes + +- remove manual sidebar generation and fix pre-render docs order ([#251](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/251)) ([eb21cb4](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/eb21cb439e746127ec0ffa128f67f0ee2e6b4767)) + +## [0.16.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.16.0...docusaurus-plugin-typedoc@0.16.1) (2021-09-17) + +### Bug Fixes + +- fix relative urls to index slug ([900e727](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/900e7276c5353b9a6fc2cd162cfe7408c070cc63)) + +# [0.16.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.3...docusaurus-plugin-typedoc@0.16.0) (2021-09-14) + +### Features + +- TypeDoc 0.22 compatibility fixes ([#249](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353)) + +## [0.15.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.2...docusaurus-plugin-typedoc@0.15.3) (2021-07-20) + +### Bug Fixes + +- Generate namespaces into own directory to fix sidebar category ([bd7669e](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/bd7669efc7eb43a91567451f3be17b5651f82a78)) +- Handle windows back-slash in slug ([#245](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/245)) ([9178963](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/917896393359426077e36149ab50b07252aafa49)) + +## [0.15.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.1...docusaurus-plugin-typedoc@0.15.2) (2021-07-12) + +### Bug Fixes + +- Handle TypeDoc 0.21.3 options breaking change ([b3be4f8](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/b3be4f807e57de7720663363b967633a57523d3e)) + +## [0.15.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.15.0...docusaurus-plugin-typedoc@0.15.1) (2021-07-03) + +### Bug Fixes + +- Fix generated sidebar dirName ([49d3a01](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/49d3a0185b9e7176f85a6de3318c9e5a0649869c)) + +# [0.15.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.14.2...docusaurus-plugin-typedoc@0.15.0) (2021-06-18) + +### Features + +- TypeDoc 0.21 compatibility ([9659567](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/9659567e439a20de57aaeeddc8abf09f787a8a97)) + +## [0.14.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.14.1...docusaurus-plugin-typedoc@0.14.2) (2021-06-01) + +### Bug Fixes + +- Use front-matter title to fix escapes angle brackets ([c5bc964](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/c5bc9645b4de81c2050271c0d85583d9bfbac531)) + +## [0.14.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.14.0...docusaurus-plugin-typedoc@0.14.1) (2021-05-06) + +### Bug Fixes + +- Fix manual sidebar backward compatibility ([#224](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/224)) ([dc873d4](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/dc873d430ff29307e29abc81f115b5033a89ab51)) + +# [0.14.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.13.0...docusaurus-plugin-typedoc@0.14.0) (2021-05-05) + +### Features + +- Replace manual sidebar logic with autogenerated sidebars ([#217](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/217)) ([a2002ca](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/a2002cabe487180f802249e9378b7b50e01fee76)) +- Update sidebar label for 'Exports' ([#223](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/223)) ([a96aa4e](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/a96aa4eb644b027ab501e9e2f998e4853a5ef18e)) + +# [0.13.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.12.1...docusaurus-plugin-typedoc@0.13.0) (2021-04-28) + +### Bug Fixes + +- Consolidate options after TypeDoc option readers ([#214](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/214)) ([14b24e4](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/14b24e4f81ec2a937985ab8317a23010c9e84419)) + +### Features + +- Update heading logic as per 'frontmatter-less' titles in alpha.73 ([62cf0d1](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/62cf0d1626289de168b71982fdbd694f0e17d21b)) + +# [0.12.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.11.0...docusaurus-plugin-typedoc@0.12.0) (2021-03-22) + +### Features + +- Remove side TOC on index page ([07ed973](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/07ed9738a1abf136e523fcd353b6a97691317c4c)) + +# [0.11.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.9.1...docusaurus-plugin-typedoc@0.11.0) (2021-03-08) + +### Bug Fixes + +- Allow plugins to be loaded with options file ([#200](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/200)) ([3a8a891](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/3a8a89136d27d68f56a399030fe6580ca4c6d36b)) + +# [0.10.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/docusaurus-plugin-typedoc@0.9.1...docusaurus-plugin-typedoc@0.10.0) (2021-02-21) + +### Features + +- Support for TypeDoc `--watch` option ([#193](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/193)). ([6ed7d97](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/6ed7d97db3ead39bdea7f5fb829ac8dc60272e49)) + +# 0.9.0 (2021-01-29) + +### Features + +- Support for `custom_edit_url` ([#190](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/190)) diff --git a/packages/docusaurus-plugin-typedoc/package.json b/packages/docusaurus-plugin-typedoc/package.json index 73dee752a..ebdc98e96 100644 --- a/packages/docusaurus-plugin-typedoc/package.json +++ b/packages/docusaurus-plugin-typedoc/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-plugin-typedoc", - "version": "1.0.0-next.30", + "version": "1.0.0", "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.", "main": "dist/index.js", "files": [ @@ -16,7 +16,7 @@ }, "homepage": "http://typedoc.org/plugins/docusaurus", "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0-next.45" + "typedoc-plugin-markdown": ">=4.0.0" }, "scripts": { "lint": "eslint ./src --ext .ts", diff --git a/packages/typedoc-github-wiki-theme/CHANGELOG.md b/packages/typedoc-github-wiki-theme/CHANGELOG.md index 1bfe6a889..b0e07767d 100644 --- a/packages/typedoc-github-wiki-theme/CHANGELOG.md +++ b/packages/typedoc-github-wiki-theme/CHANGELOG.md @@ -1,145 +1,7 @@ # Changelog -## 2.0.0-next.9 +## 2.0.0 (2024-05-03) -### Patch Changes +### Breaking Changes -- typedoc-plugin-markdown compaibility fixes: - -## 2.0.0-next.8 - -### Patch Changes - -- Compatibility fixes - -## 2.0.0-next.7 (2024-03-21) - -### Patch Changes - -- API updates from typedoc-plugin-markdown - -## 2.0.0-next.6 (2024-01-30) - -### Patch Changes - -- Updates to typedoc-plugin-markdown internal apis -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.51 - -## 2.0.0-next.5 (2024-01-30) - -### Patch Changes - -- Update core package dependency -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.44 - -## 2.0.0-next.4 (2024-01-18) - -### Patch Changes - -- Fixed sidebar output -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.41 - -## 2.0.0-next.3 (2024-01-12) - -### Patch Changes - -- Updated typedoc-plugin-markdown version -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.40 - -## 2.0.0-next.2 (2023-05-26) - -### Patch Changes - -- Allow presets to be overridden. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.13 - -## 2.0.0-next.1 (2023-05-17) - -### Patch Changes - -- Added functionality to skip seperate index page and inject into readme. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.12 - -## 2.0.0-next.0 (2023-05-13) - -### Major Changes - -- Compatibility fixes for typedoc-plugin-markdown@next - -### Patch Changes - -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.11 - -## [1.0.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.6.1...typedoc-github-wiki-theme@1.0.1) (2022-05-15) - -### Bug Fixes - -- Fixed incorrect toc anchors ([753a534](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/753a5340f8c29d692221152e0f49251f987707c8)) - -# 1.0.0 (2022-01-09) - -### BREAKING CHANGE - -Internally initiate with TypeDoc `defineTheme` method (`theme` option should be keyword rather than path) - -## [0.6.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.6.0...typedoc-github-wiki-theme@0.6.1) (2022-01-09) - -### Bug Fixes - -- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45)) - -# [0.6.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.5.1...typedoc-github-wiki-theme@0.6.0) (2021-09-21) - -### Features - -- TypeDoc 0.22 compatibility fixes ([f68442d](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/f68442d13e448d86d444e71f5781921cb4ac795e)) - -## [0.5.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.5.0...typedoc-github-wiki-theme@0.5.1) (2021-07-14) - -### Bug Fixes - -- Replace forward slash with periods for filenames ([#242](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/242)) ([69e31f2](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/69e31f2ff8e9f516897bbddefb208905ed4ecaa5)) - -# [0.5.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.3...typedoc-github-wiki-theme@0.5.0) (2021-07-13) - -### Features - -- Generate unique page names ([#242](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/242)) ([7802fd3](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/7802fd30775be167e520aaba41a04f649a569877)) - -## [0.4.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.2...typedoc-github-wiki-theme@0.4.3) (2021-07-12) - -### Bug Fixes - -- Handle TypeDoc 0.21.3 options breaking change ([38df28f](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/38df28f4ef6821c097d4ac3145984d57fad2e8a8)) - -## [0.4.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.1...typedoc-github-wiki-theme@0.4.2) (2021-06-19) - -### Bug Fixes - -- Fix output directory check ([121ffe4](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/121ffe48717db57216314b4dc7a6646bd4a1b454)) -- Remove colon from filenames to fix windows compatibility ([#237](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/237)) ([554cd44](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/554cd44b2bc48b737cfb15df8e828ceea5101d19)) - -## [0.4.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.4.0...typedoc-github-wiki-theme@0.4.1) (2021-06-19) - -### Bug Fixes - -- Remove reference to fs-extra ([#236](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/236)) ([dfec277](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/dfec277f583a398ce6f40a0ea0f2361bebab1f88)) - -# [0.4.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.3.0...typedoc-github-wiki-theme@0.4.0) (2021-06-18) - -### Features - -- TypeDoc 0.21 compatibility ([d19d6f3](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/d19d6f37a4648e48f334cf24b82b6cc9fea00abc)) - -# [0.3.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-github-wiki-theme@0.2.1...typedoc-github-wiki-theme@0.3.0) (2021-05-11) - -### Features - -- Improved sidebar structure ([58798fd](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/58798fd4b25299c8d69d6671b477973c3b896aaa)) +- typedoc-plugin-markdown dependency updated to V4. diff --git a/packages/typedoc-github-wiki-theme/package.json b/packages/typedoc-github-wiki-theme/package.json index caa0752e4..aae23370a 100644 --- a/packages/typedoc-github-wiki-theme/package.json +++ b/packages/typedoc-github-wiki-theme/package.json @@ -1,6 +1,6 @@ { "name": "typedoc-github-wiki-theme", - "version": "2.0.0-next.9", + "version": "2.0.0", "description": "A TypeDoc ( + typedoc-plugin-markdown ) theme that generates docs compatible with Github Wiki.", "main": "dist/index.js", "files": [ @@ -28,7 +28,7 @@ "author": "Thomas Grey", "license": "MIT", "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0-next.51" + "typedoc-plugin-markdown": ">=4.0.0" }, "keywords": [ "typedoc", diff --git a/packages/typedoc-gitlab-wiki-theme/CHANGELOG.md b/packages/typedoc-gitlab-wiki-theme/CHANGELOG.md index f6c6cc43b..b0e07767d 100644 --- a/packages/typedoc-gitlab-wiki-theme/CHANGELOG.md +++ b/packages/typedoc-gitlab-wiki-theme/CHANGELOG.md @@ -1,116 +1,7 @@ # Changelog -## 2.0.0-next.8 +## 2.0.0 (2024-05-03) -### Patch Changes +### Breaking Changes -- typedoc-plugin-markdown compaibility fixes: - -## 2.0.0-next.7 (2024-03-21) - -### Patch Changes - -- API updates from typedoc-plugin-markdown - -## 2.0.0-next.6 (2024-01-30) - -### Patch Changes - -- Updates to typedoc-plugin-markdown internal apis -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.51 - -## 2.0.0-next.5 (2024-01-30) - -### Patch Changes - -- Update core package dependency -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.44 - -## 2.0.0-next.4 (2024-01-18) - -### Patch Changes - -- Updated sidebar output. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.41 - -## 2.0.0-next.3 (2024-01-12) - -### Patch Changes - -- Updated typedoc-plugin-markdown version -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.40 - -## 2.0.0-next.2 (2023-05-26) - -### Patch Changes - -- Allow presets to be overridden. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.13 - -## 2.0.0-next.1 (2023-05-17) - -### Patch Changes - -- Added functionality to skip seperate index page and inject into readme. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.12 - -## 2.0.0-next.0 (2023-05-13) - -### Major Changes - -- Compatibility with typedoc-plugin-markdown@next - -### Patch Changes - -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.11 - -# 1.0.0 (2022-01-09) - -### BREAKING CHANGE - -Internally initiate with TypeDoc `defineTheme` method (`theme` option should be keyword rather than path) - -## [0.2.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.2.1...typedoc-gitlab-wiki-theme@0.2.2) (2022-01-09) - -### Bug Fixes - -- Correctly define theme using TypeDoc `defineTheme` method ([5f2ef42](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/5f2ef422aa1bcce0698e4b923682dbb106730f45)) - -## [0.2.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.2.0...typedoc-gitlab-wiki-theme@0.2.1) (2021-11-26) - -### Bug Fixes - -- **urls:** Fixes relative urls for typedoc-gitlab-wiki-theme [269] ([31e45ea](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/31e45ea5b996bf15a69b3a903fd51669d82a88e9)) - -# [0.2.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.1.2...typedoc-gitlab-wiki-theme@0.2.0) (2021-09-21) - -### Features - -- TypeDoc 0.22 compatibility fixes ([f20f79a](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/f20f79ab3c018c69bf67a2e8969880e53a2c6270)) -- TypeDoc 0.22 compatibility fixes ([#249](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/249)) ([963250c](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/963250cbe0b12bc3f413b5138d6d4e33ad2a6353)) - -## [0.1.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.1.1...typedoc-gitlab-wiki-theme@0.1.2) (2021-07-12) - -### Bug Fixes - -- Handle TypeDoc 0.21.3 options breaking change ([38df28f](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/38df28f4ef6821c097d4ac3145984d57fad2e8a8)) - -## [0.1.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.1.0...typedoc-gitlab-wiki-theme@0.1.1) (2021-06-19) - -### Bug Fixes - -- Fix output directory check ([328ef00](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/328ef00e50da988f62201c9a91548e909699c587)) -- Remove colon from filenames to fix windows compatibility ([115d133](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/115d133d296e6a7e8ceb7b46b6c88f2dbb7ee7d1)) - -# [0.1.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-gitlab-wiki-theme@0.0.1...typedoc-gitlab-wiki-theme@0.1.0) (2021-05-11) - -### Features - -- Improved sidebar structure ([09e713a](https://github.com/typedoc2md/typedoc-plugin-markdown/commit/09e713a4731fc3effceaf720bdefdba0c398d608)) +- typedoc-plugin-markdown dependency updated to V4. diff --git a/packages/typedoc-gitlab-wiki-theme/package.json b/packages/typedoc-gitlab-wiki-theme/package.json index 4b4c7c9a6..7afcb0640 100644 --- a/packages/typedoc-gitlab-wiki-theme/package.json +++ b/packages/typedoc-gitlab-wiki-theme/package.json @@ -1,6 +1,6 @@ { "name": "typedoc-gitlab-wiki-theme", - "version": "2.0.0-next.8", + "version": "2.0.0", "description": "A TypeDoc ( + typedoc-plugin-markdown ) theme that generates docs compatible with Gitlab Wiki.", "main": "dist/index.js", "files": [ @@ -28,7 +28,7 @@ "author": "Thomas Grey", "license": "MIT", "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0-next.51" + "typedoc-plugin-markdown": ">=4.0.0" }, "keywords": [ "typedoc", diff --git a/packages/typedoc-plugin-frontmatter/CHANGELOG.md b/packages/typedoc-plugin-frontmatter/CHANGELOG.md index 04d42491c..78d21ca1d 100644 --- a/packages/typedoc-plugin-frontmatter/CHANGELOG.md +++ b/packages/typedoc-plugin-frontmatter/CHANGELOG.md @@ -1,29 +1,5 @@ -# typedoc-plugin-frontmatter +# Changelog -## 1.0.0-next.1 (2024-03-21) +## 1.0.0 (2024-05-03) -### Patch Changes - -- Added `readmeFrontmatter` and `indexFrontmatter` options -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.54 - -## 0.0.3-next.0 (2024-01-15) - -### Patch Changes - -- Updated documentation. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.39 - -## 0.0.2 - -### Patch Changes - -- 4cc0ff9: - Ignore if no frontmatter data found - -## 0.0.1 - -### Patch Changes - -- db8d673: - Initial plugin release. +- First major release. diff --git a/packages/typedoc-plugin-frontmatter/package.json b/packages/typedoc-plugin-frontmatter/package.json index bbe49f2a9..62aed1034 100644 --- a/packages/typedoc-plugin-frontmatter/package.json +++ b/packages/typedoc-plugin-frontmatter/package.json @@ -1,6 +1,6 @@ { "name": "typedoc-plugin-frontmatter", - "version": "1.0.0-next.1", + "version": "1.0.0", "description": "A plugin for TypeDoc ( + typedoc-plugin-markdown ) that prepends configurable frontmatter to page content.", "main": "dist/index.js", "files": [ @@ -31,7 +31,7 @@ "yaml": "^2.3.4" }, "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0-next.54" + "typedoc-plugin-markdown": ">=4.0.0" }, "keywords": [ "frontmatter", diff --git a/packages/typedoc-plugin-markdown/CHANGELOG.md b/packages/typedoc-plugin-markdown/CHANGELOG.md index ffc8f7e27..28d3af6d7 100644 --- a/packages/typedoc-plugin-markdown/CHANGELOG.md +++ b/packages/typedoc-plugin-markdown/CHANGELOG.md @@ -4,42 +4,36 @@ > v4 is a major release that includes a number of bug fixes, new features and UI improvements. -### 🏗 Architectural Changes +### Architectural Changes - Handlebars as a dependency has been removed. - Updated customization model with the ability to set hooks, events and custom theming. - Exposed navigation structure. -### 🌟 Features +### Features - Updated output file structure. - Improved and cleaner UI. - A set of updated and additional new options with comprehensive documentation. - Exported option types and JSON schema. -### 🚀 Migrating from v3 +### Structural Changes -Migrating from v3 to v4 should be fairly straightforward. These pointers will help you understand the changes and how to update your project. +- Each module member is now output to its own file by default. See option `--outputFileStrategy`. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option `membersWithOwnFile` option. +- Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option `--parametersFormat=table`. -#### 🏗️ Structural Changes - -- Each module member is now output to its own file by default. See [`outputFileStrategy`](/docs/options#outputfilestrategy). To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the [`membersWithOwnFile`](/docs/options#memberswithownfile) option. -- Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use [`parametersFormat=table`](/docs/options#parametersformat). - -#### 💥 Breaking Changes +### Breaking Changes - Because the file structure has changed you may need to update any cross references to files in your documentation. - Setting `theme` to `"markdown"` is no longer required and should be removed. -- The option `indexTitle` has been removed. Please use the `"title.indexPage"` key with [`textContentMappings`](/docs/options#textcontentmappings). -- The option `allReflectionsHaveOwnDocument` has been removed (this behaviour is now the default). Please see See [`outputFileStrategy`](/docs/options#outputfilestrategy). +- The option `indexTitle` has been removed. Please use the `"title.indexPage"` key with option `--textContentMappings`. +- The option `allReflectionsHaveOwnDocument` has been removed (this behaviour is now the default). Please see option `outputFileStrategy`](/docs/options#outputfilestrategy). - The option `entryDocument` has been renamed to `entryFileName` to better reflect its purpose. - The option `namedAnchors` has been renamed to `useHTMLAnchors` to better reflect its purpose. -- The option `hideInPageTOC` has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using [typedoc-plugin-remark](/plugins/remark) and the [remark-toc](plugins/remark/suggested-plugins#remark-toc) plugin. -- The option `objectLiteralTypeDeclarationStyle` has been removed. Please use [`typeDeclarationFormat=list`](/docs/options#typedeclarationformat). +- The option `hideInPageTOC` has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using `typedoc-plugin-remark` and the `remark-toc` plugin. +- The option `objectLiteralTypeDeclarationStyle` has been removed. Please use option `--typeDeclarationFormat=list`. -### 🐛 Bug Fixes - -The release features numerous bug fixes including: +### Bug Fixes - Duplication in callback/callable/function properties. ([#581](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/581)). - @experimental / @internal annotations. ([#556](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/556)) @@ -69,15 +63,6 @@ The release features numerous bug fixes including: - Properties as Table like function properties. ([#109](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/109)) - Provide a link/excerpt/screenshot to a demo/example rendered outpout ([#102](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/102)) - +Earlier changelog entries can be found in `CHANGELOG_ARCHIVE.md`. diff --git a/packages/typedoc-plugin-markdown/CHANGELOG_V3..md b/packages/typedoc-plugin-markdown/CHANGELOG_ARCHIVE..md similarity index 63% rename from packages/typedoc-plugin-markdown/CHANGELOG_V3..md rename to packages/typedoc-plugin-markdown/CHANGELOG_ARCHIVE..md index ec67b6adb..b48c8129b 100644 --- a/packages/typedoc-plugin-markdown/CHANGELOG_V3..md +++ b/packages/typedoc-plugin-markdown/CHANGELOG_ARCHIVE..md @@ -1,456 +1,70 @@ -# Changelog +# Changelog (Archive) -## 4.0.0-next.60 +## [3.17.1](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.17.0...typedoc-plugin-markdown@3.17.1) (2023-11-06) -### Patch Changes - -- Added footer partial and footer.text mappings. -- remove header readme labell - -## 4.0.0-next.59 - -### Patch Changes - -- Removed deprecated options. -- Tweaked link behaviour in page header. -- Added symbols to external links. - -## 4.0.0-next.58 - -### Patch Changes - -- Fixed navigation type error ([#595](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/595)) - -## 4.0.0-next.57 - -### Patch Changes - -- Fix broken links in packages index. -- Added `navigationModel` option. - -## 4.0.0-next.56 - -### Patch Changes - -- Expose 'Default value` column to properties table. -- Added sanitizeComments option. -- Navigation structure updates. - -## 4.0.0-next.55 (2024-04-05) - -### Patch Changes - -- Added `flattenOutputFiles` option. -- Lowercased `Object` keyword. - -## 4.0.0-next.54 (2024-03-21) - -### Patch Changes - -- Added `fileExtension` option. -- Expose `membersWithOwnFile`, `preserveMarkup` and `excludeScopesInPaths` options. -- Improve signature ui. -- Exposed additional file options to packages -- Fix index table format for packages. - -## 4.0.0-next.53 (2024-02-07) - -### Patch Changes - -- Fixed omitted object literal default values. - -## 4.0.0-next.52 (2024-02-07) - -### Patch Changes - -- Expose `useMDXFileExt` option. -- Fix hooks being called in incorrect order. - -## 4.0.0-next.51 (2024-02-07) - -### Patch Changes - -- Remove blockquotes on signature and declarations. -- Minor ui tweaks. -- Expose `expandParameters` option. - -## 4.0.0-next.50 (2024-02-01) - -### Patch Changes - -- Fix "undefined" custom `@group` headings. - -## 4.0.0-next.49 (2024-02-01) - -### Patch Changes - -- Fixed `publicPath` implemention. - -## 4.0.0-next.48 (2024-02-01) - -### Patch Changes - -- Ignore seperate module index when `entryModule` is defined. - -## 4.0.0-next.47 (2024-01-31) - -### Patch Changes - -- Fix params being incorrectly escaped in list format. -- Removed generator in footer. -- Fix typing of the defineTheme method. - -## 4.0.0-next.46 (2024-01-31) - -### Patch Changes - -- Allow jsx style curly braces in comments. - -## 4.0.0-next.45 (2024-01-31) - -### Patch Changes - -- Escape curly braces inside comment blocks. - -## 4.0.0-next.44 (2024-01-30) - -### Patch Changes - -- Expose `textContentMappings` to navigation -- Expose theme hooks similar to default theme. -- Expose TypedDoc media and include syntax. -- Expose `@experimental` and `@internal` doc flags -- Handle symbols with same name when generating urls -- Expose version to breadcrumbs.home text mapping - -## 4.0.0-next.43 - -### Patch Changes - -- Updated documentation - -## 4.0.0-next.42 - -### Patch Changes - -- Fixed navigation structure -- Updated documentation - -## 4.0.0-next.41 (2024-01-18) - -### Patch Changes - -- Fix incorrect anchor slugs on urls -- Exposed function keyword to code blocks. -- Fixed some incorrect navigation structures. - -## 4.0.0-next.40 (2024-01-12) - -### Patch Changes - -- Changed named anchors to a boolean -- Remove page title from merged readme -- Deprecate hideInPageTOC option - -## 4.0.0-next.39 (2024-01-07) - -### Patch Changes - -- Update ui for @eventProperty tags -- Added `textContentMappings` option - -## 4.0.0-next.38 (2023-12-18) - -### Patch Changes - -- Packages output file fixes - -## 4.0.0-next.37 (2023-12-15) - -### Patch Changes - -- Enable outputFileStrategy in "packages" mode - -## 4.0.0-next.36 (2023-12-03) - -### Patch Changes - -- Updated breadcrumbs UI - -## 4.0.0-next.35 (2023-12-01) - -### Patch Changes - -- Fixed `mergeReadme` for packages entryPointStrategy - -## 4.0.0-next.34 (2023-11-30) - -### Patch Changes - -- Expose `mergeReadme` option - -## 4.0.0-next.33 (2023-11-30) - -### Patch Changes - -- Exposed `publicPath` option - -## 4.0.0-next.32 (2023-11-29) - -### Patch Changes - -- Generate packages.md even if groups used - -## 4.0.0-next.31 (2023-11-24) - -### Patch Changes - -- Strikethough members marked as deprecated -- Expose returned declarations for reference types - -## 4.0.0-next.30 (2023-11-22) - -### Patch Changes - -- Update header UI - -## 4.0.0-next.29 (2023-11-19) - -### Patch Changes - -- Fixed paraterTable style on declarations -- UI updates - -## 4.0.0-next.28 (2023-11-18) - -### Patch Changes - -- Expose `--entryModule` option -- UI updates to header and breadcrumbs -- Prevent MDX parsing symbols as markdown links - -## 4.0.0-next.27 (2023-11-07) - -### Patch Changes - -- Preserve slash in module filenames - -## 4.0.0-next.26 (2023-11-07) - -### Patch Changes - -- Support angle brackets, slashes and leading numbers in module names - -## 4.0.0-next.25 (2023-10-29) - -### Patch Changes - -- Fixed missing return types -- Added --mergeReadme option -- Tweaked and added specs for reference types -- Updated default `--indexPageTitle` to {projectName} -- Renamed `--titleTemplate` -> `--memberPageTitle` - -## 4.0.0-next.24 (2023-10-21) - -### Patch Changes - -- Correctly resolve packge readme urls from member pages ([#483](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/483)) -- Prevent trigger of reversed link syntax rule on index access types ([#484](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/484)) - -## 4.0.0-next.23 (2023-10-09) - -### Patch Changes - -- Updated toc implementation -- Fixed indexPageTitle optio - -## 4.0.0-next.22 (2023-09-26) - -### Patch Changes - -- Updated index filenames and Removed indexFileName option - -## 4.0.0-next.21 (2023-09-25) - -### Patch Changes - -- Several ui improvements -- Simplified option names -- Improved documentation -- Fixed and refactored tests - -## 4.0.0-next.20 (2023-08-29) - -### Patch Changes - -- UI improvements -- Enable anchor to items inside table - -## 4.0.0-next.19 (2023-08-27) - -### Patch Changes - -- TypeDoc 0.25.0 compatibility fixes - -## 4.0.0-next.18 (2023-08-10) - -### Patch Changes - -- Split out comment summary and tags for signatures -- Added `titleTemplate` option to replace hideKindPrefix option -- Fixed incorrect heading title for monorepo packages -- Disable in-built Prettier formatting - -## 4.0.0-next.17 (2023-07-07) - -### Patch Changes - -- Prettier 3.0 support - -## 4.0.0-next.16 (2023-06-13) - -### Patch Changes - -- Omit number prefixes from index files - -## 4.0.0-next.15 (2023-06-13) - -### Patch Changes - -- Remove namespace from module filenames - -## 4.0.0-next.14 (2023-06-12) - -### Patch Changes - -- Export plugin options - -## 4.0.0-next.13 (2023-05-26) - -### Patch Changes - -- Added ability to easily override templates for custom theming. -- Correct typo in the option `identifiersAsCodeBlocks`. -- UI fixes. -- Expose docs for intersection type literals. -- Allow HTML inside code blocks. - -## 4.0.0-next.12 (2023-05-17) - -### Patch Changes - -- Ensure unique file names for symbols with same name with `flattenOutputFiles` -- Added functionality to skip seperate index page and inject into readme. - -## 4.0.0-next.11 (2023-05-13) - -### Patch Changes - -- Simplified fileoutput options - replaced kindsWithOwnFile option with an easier to understand `outputFileStrategy` option (see docs) -- Extract frontmatter logic into seperate TypeDoc plugin -- Fix fileoutput for 'packages' entryPointStrategy -- Tweaked header/breadcrumbs -- Escape angle brackets in comment blocks unless inside backticks ([#276](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/276)) -- UI tweaks to properties display - -## 4.0.0-next.10 - -### Patch Changes - -- Fix pipes not being escaped correctly with union types in properties table -- Exposed navigation object to renderer -- General UI updates and fixes - -## 4.0.0-next.9 - -### Patch Changes +### Features -- Discover prettier config files +- Prevent escaping of angle brackets in toc [(#495)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/495) -## 4.0.0-next.8 +## [3.17.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.16.0...typedoc-plugin-markdown@3.17.0) (2023-11-01) -### Patch Changes +### Features -- Added `numberPrefixOutput` and `hideKindPrefix` options -- Support `includeVersion` -- Decoupled renderer methods -- Further refactoring and fixes +- Support MDXv2 -## 4.0.0-next.7 +## [3.16.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.15.4...typedoc-plugin-markdown@3.16.0) (2023-08-26) -### Patch Changes +### Fixes -- Added `identifiersAsCodeBlocks`, `propertiesFormat`, `typeDeclarationFormat`, `enumMembersFormat` options. -- Renamed `reflectionsWithOwnFile`=>`kindsWithOwnFile` and `groupByReflections`=>`groupByKinds`. -- General ui tweaks and fixes +- TypeDoc 0.25 compatibility fixes. -## 4.0.0-next.6 +## [3.15.4](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.15.3...typedoc-plugin-markdown@3.15.4) (2022-07-24) -### Patch Changes +### Fixes -- Refactored fileoutput options (renamed symbolsWithOwnFile=>reflectionsWithOwnFile, groupBySymbols=>groupByReflections) +- Split out comment summary and tags for signatures [(#451)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/451) -## 4.0.0-next.5 +## [3.15.3](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.15.2...typedoc-plugin-markdown@3.15.3) (2023-04-29) -### Patch Changes +### Fixes -- Fix incorrect heading levels -- Slugify output filenames -- Expose `groupBySymbols` option +- Updated dependencies -## 4.0.0-next.4 +## [3.15.2](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.15.1...typedoc-plugin-markdown@3.15.2) (2023-04-20) -### Patch Changes +### Fixes -- Mark final default parameters as optional ([#396](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/396)) +- Support `includeVersion' option [(#415)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/415) -- Run prettier on output files ([#398](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/398)) +# [3.15.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.14.0...typedoc-plugin-markdown@3.15.0) (2023-04-11) -- Replace new lines in tables with `
` ([#331](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/331)) +### Features - TypdeDoc 0.24 compatibility fixes. -- Escape curly braces in type declarations - -## 4.0.0-next.3 - -### Patch Changes - -- Expose referenced type links on declaration -- UI fixes - -## 4.0.0-next.2 +# [3.14.0](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.6...typedoc-plugin-markdown@3.14.0) (2022-12-02) -### Patch Changes - -- Fix optional declarations in code blocks -- Improve hierarchy output +### Features -## 4.0.0-next.1 +- Add objectLiteralTypeDeclarationStyle option ([#362](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/362)) +- Beautify parameter table output of destructured params ([#364](https://github.com/typedoc2md/typedoc-plugin-markdown/pull/364)) -### Minor Changes +### Fixes -- Expose Frontmatter options ([#384](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/384)), ([#360](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/360)) -- Convert comment `@tags` to headings -- Export files following module structure as default -- UI improvemements +- Fix missing descriptions for function params ([#357](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/357)) +- Add conditional check to signature comments ([#368](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/368)) -### Patch Changes +## [3.13.6](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.5...typedoc-plugin-markdown@3.13.6) (2022-09-04) -- Respect monorepo `readmeFile` configuration ([#383](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/383)) -- Fix incorrect heading levels on project reflections +### Fixes -## 4.0.0-next.0 +- Replace deprecated 'attemptExternalResolution' [(#344)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/344) -### Major Changes +## [3.13.5](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.4...typedoc-plugin-markdown@3.13.5) (2022-08-30) -Initial release of next version. In summary includes: +### Fixes -- Removal of handlebars. -- MDX2 support as standard ([(#305)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/305), [(#252)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/252)). -- Exposes additional output file options ([(#353)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/353), [(#338)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/338), [(#328)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/328), [(#307)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/307)). -- Several UI improvements. +- Export media and includes options [(#340)](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/340) ## [3.13.4](https://github.com/typedoc2md/typedoc-plugin-markdown/compare/typedoc-plugin-markdown@3.13.3...typedoc-plugin-markdown@3.13.4) (2022-07-20) diff --git a/packages/typedoc-plugin-markdown/package.json b/packages/typedoc-plugin-markdown/package.json index 9eb00b09f..d59829d61 100644 --- a/packages/typedoc-plugin-markdown/package.json +++ b/packages/typedoc-plugin-markdown/package.json @@ -1,6 +1,6 @@ { "name": "typedoc-plugin-markdown", - "version": "4.0.0-next.60", + "version": "4.0.0", "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.", "main": "dist/index.js", "files": [ diff --git a/packages/typedoc-plugin-remark/CHANGELOG.md b/packages/typedoc-plugin-remark/CHANGELOG.md index 2498eb0e5..78d21ca1d 100644 --- a/packages/typedoc-plugin-remark/CHANGELOG.md +++ b/packages/typedoc-plugin-remark/CHANGELOG.md @@ -1,33 +1,5 @@ -# typedoc-plugin-remark +# Changelog -## 1.0.0-next.4 +## 1.0.0 (2024-05-03) -### Major Changes - -- Updated version - -## 0.0.1-next.3 (2024-04-06) - -### Patch Changes - -- Enable frontmatter and GFM compatibility - -## 0.0.1-next.2 (2024-01-12) - -### Patch Changes - -- Fix options not being passed to remark plugins - -## 0.0.1-next.1 (2024-01-12) - -### Patch Changes - -- Updated typedoc-plugin-markdown version -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.40 - -## 0.0.1-next.0 (2024-01-12) - -### Patch Changes - -- Updated documentation. +- First major release. diff --git a/packages/typedoc-plugin-remark/package.json b/packages/typedoc-plugin-remark/package.json index f716a0d56..ef10a4a92 100644 --- a/packages/typedoc-plugin-remark/package.json +++ b/packages/typedoc-plugin-remark/package.json @@ -1,6 +1,6 @@ { "name": "typedoc-plugin-remark", - "version": "1.0.0-next.4", + "version": "1.0.0", "description": "A plugin for TypeDoc ( + typedoc-plugin-markdown ) that enables additional markdown transformations with remark plugins.", "main": "./dist/index.js", "files": [ @@ -31,7 +31,7 @@ "to-vfile": "^8.0.0" }, "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0-next.40" + "typedoc-plugin-markdown": ">=4.0.0" }, "keywords": [ "typedoc", diff --git a/packages/typedoc-vitepress-theme/CHANGELOG.md b/packages/typedoc-vitepress-theme/CHANGELOG.md index 55e6fd209..78d21ca1d 100644 --- a/packages/typedoc-vitepress-theme/CHANGELOG.md +++ b/packages/typedoc-vitepress-theme/CHANGELOG.md @@ -1,97 +1,5 @@ -# typedoc-vitepress-theme +# Changelog -## 1.0.0-next.11 +## 1.0.0 (2024-05-03) -### Patch Changes - -- typedoc-plugin-markdown compaibility fixes: - -## 1.0.0-next.10 (2024-03-21) - -### Patch Changes - -- API updates from typedoc-plugin-markdown - -## 1.0.0-next.9 (2024-01-18) - -### Patch Changes - -- Updates to typedoc-plugin-markdown internal apis -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.51 - -## 1.0.0-next.8 (2024-01-18) - -### Patch Changes - -- Update core package dependency -- Replace `/index.md` with `/` on sidebar root paths -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.44 - -## 1.0.0-next.7 (2024-01-18) - -### Patch Changes - -- Expose `docsRoot` option ([#540](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/540)) -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.41 - -## 1.0.0-next.6 (2024-01-12) - -### Patch Changes - -- Fix sidebar types -- Rename sidebar.collapse=>sidebar.collapsed - -## 1.0.0-next.5 (2024-01-12) - -### Patch Changes - -- Updated typedoc-plugin-markdown version -- Exposed additional sidebar options -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.40 - -## 1.0.0-next.4 (2024-01-07) - -### Patch Changes - -- Updated documentation. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.39 - -## 1.0.0-next.3 (2023-08-27) - -### Patch Changes - -- TypeDoc 0.25.0 compatibility fixes -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.19 - -## 1.0.0-next.2 (2023-05-26) - -### Patch Changes - -- Allow presets to be overridden. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.13 - -## 1.0.0-next.1 (2023-05-17) - -### Patch Changes - -- Added functionality to skip seperate index page and inject into readme. -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.12 - -## 1.0.0-next.0 (2023-05-13) - -### Major Changes - -- Initial commit - -### Patch Changes - -- Updated peer dependencies - - typedoc-plugin-markdown@4.0.0-next.11 +- First major release. diff --git a/packages/typedoc-vitepress-theme/package.json b/packages/typedoc-vitepress-theme/package.json index 69baf7ccd..8df8b5773 100644 --- a/packages/typedoc-vitepress-theme/package.json +++ b/packages/typedoc-vitepress-theme/package.json @@ -1,6 +1,6 @@ { "name": "typedoc-vitepress-theme", - "version": "1.0.0-next.11", + "version": "1.0.0", "description": "A TypeDoc ( + typedoc-plugin-markdown ) theme that generates markdown compatible with VitePress.", "main": "./dist/index.js", "files": [ @@ -27,7 +27,7 @@ "test:update": "npm run build && npm test -- -u" }, "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0-next.51" + "typedoc-plugin-markdown": ">=4.0.0" }, "license": "MIT", "keywords": [