Skip to content

Commit

Permalink
Merge pull request #456 from fuma-nama/dev
Browse files Browse the repository at this point in the history
Sync
  • Loading branch information
fuma-nama authored Jun 13, 2024
2 parents 1496cfc + cd01fa1 commit 3f3e942
Show file tree
Hide file tree
Showing 19 changed files with 85 additions and 31 deletions.
5 changes: 0 additions & 5 deletions .changeset/chilly-rabbits-fail.md

This file was deleted.

1 change: 1 addition & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@
"baseBranch": "dev",
"updateInternalDependencies": "patch",
"privatePackages": { "version": false },
"bumpVersionsWithWorkspaceProtocolOnly": true,
"ignore": ["docs", "example-*"]
}
5 changes: 0 additions & 5 deletions .changeset/silly-schools-cheer.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/ten-poets-bow.md

This file was deleted.

6 changes: 0 additions & 6 deletions .changeset/three-pants-sin.md

This file was deleted.

4 changes: 2 additions & 2 deletions apps/docs/content/blog/2024-5-16.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Binary file added apps/docs/content/blog/links-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/content/blog/toc-popover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions apps/docs/content/blog/v12-after.mdx
Original file line number Diff line number Diff line change
@@ -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.

<div className='mx-auto max-w-[400px]'>

![Preview](./toc-popover.png)

</div>

### 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 `<RootToggle />` or include it in page trees.
- Other links: Use the Links API of docs layout.

<div className='mx-auto max-w-[400px]'>

![Preview](./links-menu.png)

</div>

### 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.
2 changes: 1 addition & 1 deletion packages/contentlayer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"unified": "^11.0.4"
},
"peerDependencies": {
"fumadocs-core": "12.0.3"
"fumadocs-core": "12.x.x"
},
"publishConfig": {
"access": "public"
Expand Down
7 changes: 7 additions & 0 deletions packages/core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 2 additions & 0 deletions packages/create-app/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# create-next-docs-app

## 12.0.4

## 12.0.3

## 12.0.2
Expand Down
2 changes: 1 addition & 1 deletion packages/create-app/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/create-app/versions.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"fumadocs-core":"12.0.0","fumadocs-ui":"12.0.0","fumadocs-mdx":"8.2.28","fumadocs-contentlayer":"1.1.30"}
{"fumadocs-core":"","fumadocs-ui":"","fumadocs-mdx":"","fumadocs-contentlayer":""}
2 changes: 1 addition & 1 deletion packages/mdx/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
"webpack": "^5.90.3"
},
"peerDependencies": {
"fumadocs-core": "12.0.3",
"fumadocs-core": "12.x.x",
"next": ">= 14.1.0"
},
"publishConfig": {
Expand Down
11 changes: 11 additions & 0 deletions packages/ui/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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]
- [email protected]

## 12.0.3

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 2 additions & 2 deletions packages/ui/src/components/layout/sidebar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,8 @@ function NodeList({

return (
<div {...props}>
{items.map((item) => {
const id = `${item.type}_${item.name}`;
{items.map((item, i) => {
const id = `${item.type}_${i.toString()}`;

switch (item.type) {
case 'separator':
Expand Down

0 comments on commit 3f3e942

Please sign in to comment.