Skip to content

feat: use fumadocs for website #1654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

feat: use fumadocs for website #1654

wants to merge 16 commits into from

Conversation

nperez0111
Copy link
Contributor

@nperez0111 nperez0111 commented May 2, 2025

This PR implements a new docs site, based on fumadocs.

I purposefully did not just update the existing docs site, so that we can compare the changes, and remove any cruft that may be left over.

So far, I've done the following:

  • Implemented the docs and examples content pages (with slight modifications to the content since titles are now generated from the frontmatter of the mdx files)
  • Moved over the pricing page (a one-off page that was in React)
  • Moved over the thank you page (an mdx page)
  • Moved over the sign in/sign up pages and functionality and put the sign in button in the header
  • Added an llms.txt and llms-full.txt file which are automatically generated from the docs content (useful for LLMs to understand out APIs)

What's left:

image

Copy link

vercel bot commented May 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
blocknote ❌ Failed (Inspect) Jul 4, 2025 9:33pm
blocknote-website ❌ Failed (Inspect) Jul 4, 2025 9:33pm

* Added home and about pages

* docs: Examples, footer, and remaining pages (#1784)

* Added examples card grid and fixed demo styling

* Added footer + remaining pages, cleaned up files

* Removed unused Logo component

* - Fixed home page contributors GH/Discord icons
- Fixed CSS file imports
- Removed codeblock/tabs from generated example MDX files (now handled by the `Example` component)
- Fixed component imports in MDX
- Refactored `Example` component
- Various styling fixes
- Added `meta.json` generation

* Fixed pro examples + minor changes/fixes

* Small fix

* Small fix

* Removed `console.log`

* Added missing examples pages to meta

* Small fix

* Fixed build

* Updated package lock

* Updated lockfile

* Fixed example path in playground

* Implemented PR feedback

* Updated page headings
Copy link
Collaborator

@YousefED YousefED left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Not really a lot of questions about the code - so focused on testing the design / different pages.

Generic:

AI:

Do we need to merge in changes from main?

  • AI button doesn't show in header
  • AI preview banner has been removed (maybe need to merge in updates from main)

Navbar:

  • examples / docs aren't highlighted in navigation when that page is active
  • can we make the navigation more consistent between docs and main pages?
  • remove light / dark toggle from nav (keep in footer like existing site)

Other:

Let's walk through the pages together and manually compare them (maybe on a call), with specific attention to dark + light, responsive, etc. We can then see together what we do / do not want to fix. Some things I already noticed (outside of the above):

  • dark mode sign in / sign up page looks a lot different


If you're looking to work on BlockNote itself, check the [`packages`](/packages/) folder.

## Getting Started
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

streamline with DEVELOPMENT or link to that file


export const runtime = "edge";

export async function GET(request: Request) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: make sure we test this when deployed

import { Hero } from "./hero/Hero";
import { Letter } from "./letter/Letter";

export default function Home() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this directory named (home)? Is this a route group? https://nextjs.org/docs/app/api-reference/file-conventions/route-groups ? Should it be? (as it's a single page, right?)

import { baseOptions } from "@/app/layout.config";
import { Footer } from "@/components/Footer";

export default function Layout({ children }: { children: ReactNode }) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

trying to understand the setup, for which pages is this layout file used?

- Made Pro badge inline and on the right side of tabs
- Moved sign in button to the right side
- Fixed banner movement & styles
- Made sidebar same bg color as page
- Fixed auth page styling
- Fixed CTA button text wrap
- Reverted to fumadocs native theme toggle in footer
- Reduced logo size in footer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants