diff --git a/.changeset/chilly-rabbits-fail.md b/.changeset/chilly-rabbits-fail.md deleted file mode 100644 index cda330a2c..000000000 --- a/.changeset/chilly-rabbits-fail.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'fumadocs-ui': patch ---- - -Hide file name on breadcrumbs diff --git a/.changeset/config.json b/.changeset/config.json index 9d1dc11e4..9033d4c30 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -8,5 +8,6 @@ "baseBranch": "dev", "updateInternalDependencies": "patch", "privatePackages": { "version": false }, + "bumpVersionsWithWorkspaceProtocolOnly": true, "ignore": ["docs", "example-*"] } diff --git a/.changeset/silly-schools-cheer.md b/.changeset/silly-schools-cheer.md deleted file mode 100644 index 226e2220d..000000000 --- a/.changeset/silly-schools-cheer.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'fumadocs-core': patch ---- - -Support `ReactNode` in page tree, table of contents and breadcrumb type definitions diff --git a/.changeset/ten-poets-bow.md b/.changeset/ten-poets-bow.md deleted file mode 100644 index 8a033cd55..000000000 --- a/.changeset/ten-poets-bow.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'fumadocs-ui': patch ---- - -Improve design details diff --git a/.changeset/three-pants-sin.md b/.changeset/three-pants-sin.md deleted file mode 100644 index 5e8262044..000000000 --- a/.changeset/three-pants-sin.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'fumadocs-core': patch -'fumadocs-ui': patch ---- - -Support including separators in breadcrumbs diff --git a/apps/docs/content/blog/2024-5-16.mdx b/apps/docs/content/blog/2024-5-16.mdx index 1ecfb12e4..04139e54e 100644 --- a/apps/docs/content/blog/2024-5-16.mdx +++ b/apps/docs/content/blog/2024-5-16.mdx @@ -24,13 +24,13 @@ At least, I'll check my attribute before firing an issue on somebody else's Gith ### Issues -My favourite dev was [Anthony Shew](https://shew.dev), I must mention him because [the issue he opened](https://github.com/fuma-nama/fumadocs/issues/264), **is the best I've ever seen in my open-source career**. +My favourite dev was [Anthony Shew](https://shew.dev), I mentioned him because [the issue he opened](https://github.com/fuma-nama/fumadocs/issues/264) is the best I've ever seen in my open-source career. He actually cared about my vision and opinion about the API design, and gave a really concise and constructive feature request. Obviously, I was not a perfect, neither an experienced library dev. Fumadocs wasn't capable of many things, such a well-explained feature request and idea is powerful. His passion is inspiring. -Before setting up the YAML issue template, there were very few issues that actually follow the issue template, most of them don't even provide a reproducible repository, or an explanation. +Before setting up the YAML issue template, there were very few issues that actually followed the issue template, most of them don't even provide a reproducible repository, or an explanation. **Open a proper issue, follow the instructions, and give maintainers some positive feedback.** This is the biggest motivation you can give to the maintainers without money. diff --git a/apps/docs/content/blog/links-menu.png b/apps/docs/content/blog/links-menu.png new file mode 100644 index 000000000..5474dab7c Binary files /dev/null and b/apps/docs/content/blog/links-menu.png differ diff --git a/apps/docs/content/blog/toc-popover.png b/apps/docs/content/blog/toc-popover.png new file mode 100644 index 000000000..c5d96c1a4 Binary files /dev/null and b/apps/docs/content/blog/toc-popover.png differ diff --git a/apps/docs/content/blog/v12-after.mdx b/apps/docs/content/blog/v12-after.mdx new file mode 100644 index 000000000..d314e8bd5 --- /dev/null +++ b/apps/docs/content/blog/v12-after.mdx @@ -0,0 +1,54 @@ +--- +title: Fumadocs 12.0.5 +description: After the release of Fumadocs 12 +date: 2024-06-13 +author: Fuma Nama +--- + +## Some Improvements + +After releasing Fumadocs 12, some improvements are made to the new UI. + +### TOC Popover + +Previously, this was only available on larger devices. Now, it's collapsed to a popover on smaller devices. + +
+ +![Preview](./toc-popover.png) + +
+ +### Links Menu + +To make the sidebar looks even better, we moved navigation links to the links menu (the three-dots button at the top corner). + +The recommended design is: + +- Docs related links: Use `` or include it in page trees. +- Other links: Use the Links API of docs layout. + +
+ +![Preview](./links-menu.png) + +
+ +### Breadcrumbs + +Removed the duplicated page name from breadcrumbs, now it only shows the folder names. +Also, you can enable `includeSeparators` to show separators on your breadcrumbs component. + +The new breadcrumbs look cleaner and match the design even better. + +## Adaption + +Some docs sites such as https://yeecord.com and https://turbo.build adapted the new UI, I'm very excited about it. +Removing the navbar seemed to be a very risky move to me, almost no documentation framework had made it, and I was expecting some complaints about the new design. + +Luckily, most people are satisfied about the new UI. +The new design was originally inspired by Arc, their sidebar looked very impressive to me. +Although I soon discovered the docs site of Linear also doesn't have a navbar, Arc is still the first inspiration of the redesign. + +I'm grateful that many people gave me their feedback about the new design, so that I can keep making Fumadocs a better framework to use. +Let's make a better docs. diff --git a/packages/contentlayer/package.json b/packages/contentlayer/package.json index 073add1de..d41d69e0b 100644 --- a/packages/contentlayer/package.json +++ b/packages/contentlayer/package.json @@ -54,7 +54,7 @@ "unified": "^11.0.4" }, "peerDependencies": { - "fumadocs-core": "12.0.3" + "fumadocs-core": "12.x.x" }, "publishConfig": { "access": "public" diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index fcc038168..5a60db44c 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,12 @@ # next-docs-zeta +## 12.0.4 + +### Patch Changes + +- 72dbaf1: Support `ReactNode` in page tree, table of contents and breadcrumb type definitions +- 51ca944: Support including separators in breadcrumbs + ## 12.0.3 ### Patch Changes diff --git a/packages/core/package.json b/packages/core/package.json index d4f0447e1..b54e4a026 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "fumadocs-core", - "version": "12.0.3", + "version": "12.0.4", "description": "The library for building a documentation website in Next.js", "keywords": [ "NextJs", diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md index 0c8afd171..cf29a164a 100644 --- a/packages/create-app/CHANGELOG.md +++ b/packages/create-app/CHANGELOG.md @@ -1,5 +1,7 @@ # create-next-docs-app +## 12.0.4 + ## 12.0.3 ## 12.0.2 diff --git a/packages/create-app/package.json b/packages/create-app/package.json index 79dce8cb5..7f4dffa80 100644 --- a/packages/create-app/package.json +++ b/packages/create-app/package.json @@ -1,6 +1,6 @@ { "name": "create-fumadocs-app", - "version": "12.0.3", + "version": "12.0.4", "description": "Create a new documentation site with Fumadocs", "keywords": [ "NextJs", diff --git a/packages/create-app/versions.json b/packages/create-app/versions.json index 05853811e..938cfa824 100644 --- a/packages/create-app/versions.json +++ b/packages/create-app/versions.json @@ -1 +1 @@ -{"fumadocs-core":"12.0.0","fumadocs-ui":"12.0.0","fumadocs-mdx":"8.2.28","fumadocs-contentlayer":"1.1.30"} \ No newline at end of file +{"fumadocs-core":"","fumadocs-ui":"","fumadocs-mdx":"","fumadocs-contentlayer":""} \ No newline at end of file diff --git a/packages/mdx/package.json b/packages/mdx/package.json index 8f2320413..97ae50f41 100644 --- a/packages/mdx/package.json +++ b/packages/mdx/package.json @@ -64,7 +64,7 @@ "webpack": "^5.90.3" }, "peerDependencies": { - "fumadocs-core": "12.0.3", + "fumadocs-core": "12.x.x", "next": ">= 14.1.0" }, "publishConfig": { diff --git a/packages/ui/CHANGELOG.md b/packages/ui/CHANGELOG.md index b7bff9f2d..a9c89f783 100644 --- a/packages/ui/CHANGELOG.md +++ b/packages/ui/CHANGELOG.md @@ -1,5 +1,16 @@ # next-docs-ui +## 12.0.4 + +### Patch Changes + +- 70666d8: Hide file name on breadcrumbs +- f96da27: Improve design details +- 51ca944: Support including separators in breadcrumbs +- Updated dependencies [72dbaf1] +- Updated dependencies [51ca944] + - fumadocs-core@12.0.4 + ## 12.0.3 ### Patch Changes diff --git a/packages/ui/package.json b/packages/ui/package.json index 01bc9d752..a509d4a81 100644 --- a/packages/ui/package.json +++ b/packages/ui/package.json @@ -1,6 +1,6 @@ { "name": "fumadocs-ui", - "version": "12.0.3", + "version": "12.0.4", "description": "The framework for building a documentation website in Next.js", "keywords": [ "NextJs", diff --git a/packages/ui/src/components/layout/sidebar.tsx b/packages/ui/src/components/layout/sidebar.tsx index 5b944b12b..68c322718 100644 --- a/packages/ui/src/components/layout/sidebar.tsx +++ b/packages/ui/src/components/layout/sidebar.tsx @@ -184,8 +184,8 @@ function NodeList({ return (
- {items.map((item) => { - const id = `${item.type}_${item.name}`; + {items.map((item, i) => { + const id = `${item.type}_${i.toString()}`; switch (item.type) { case 'separator':