Docusaurus.community

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

This website is built using Docusaurus 3, a modern static website generator.

Installation

Use a supported Node.js LTS release (Node.js 22 or newer) and the Yarn version pinned in package.json. The installed Docusaurus version requires Node.js 20 or newer, even though this repository's engines field still lists an older minimum.

Enable Corepack so the pinned Yarn version is used:

corepack enable
yarn install --immutable

If corepack is not available in your Node.js installation, install it with npm install --global corepack first. Do not run yarn set version stable in this repository unless you intend to upgrade its package manager.

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Preview the production build locally with yarn serve. Run yarn typecheck to check TypeScript; there are currently known errors in shared components, so report any new diagnostics separately.

Community homepage and theme

The homepage highlights the knowledge base, plugin directory, and ways to contribute. Its curated notebook and topic links point to existing community content; update these alongside the content they feature. Keep recommendations descriptive rather than implying popularity or endorsement.

Homepage styles use the shared --cp-* palette in the community theme, which is loaded after the existing custom styles. The shared theme maps those tokens to Infima so documentation and the plugin directory use the same visual language without replacing their layouts. Existing admonition and syntax-highlighting colours retain their semantic meaning.

Docusaurus owns theme detection and persistence, including the native light/dark switch and operating system preference. Avoid adding a separate theme-detection script that would compete with it. Keep keyboard focus visible, respect reduced-motion preferences, and check both themes at mobile and desktop widths when changing the design. Run yarn typecheck and yarn build before submitting changes.

Navbar action links use icons on desktop and show their text labels in the mobile menu. Keep the aria-label, title, and .navbar__action-label text in sync when editing them in the site configuration. Font Awesome icons are rendered at build time; the Docusaurus icon uses the existing local brand asset.

The community brand uses a dinosaur inside a speech bubble, with light and dark navbar assets and a simplified favicon. The Logo theme component renders the two-tone wordmark in both the desktop navbar and mobile menu. Keep the two mark variants geometrically identical. The green Docusaurus icon in the external link and footer still identifies the upstream project.

The default social share image is community-social-card.png (1200 x 630). Its editable source is community-social-card.svg. After editing the SVG, regenerate the PNG from the repository root with the existing Sharp dependency:

yarn node -e "require('sharp')('static\\img\\community-social-card.svg').png().toFile('static\\img\\community-social-card.png').catch(error => { console.error(error); process.exitCode = 1 })"

The site configuration uses the PNG for Open Graph and Twitter cards, since social crawlers do not reliably support SVG previews. The image is intentionally fixed to the light brand palette. If its dimensions change, update og:image:width and og:image:height in the site configuration to match the exported PNG.

Deployment

This repository deploys to Cloudflare Pages, not GitHub Pages. The Publish workflow builds and deploys changes pushed to main. Pull requests from the same repository receive preview deployments. For forked pull requests, a maintainer must review the changes and add the 🚀request-deploy label to request deployment.

The workflow requires the CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_API_TOKEN repository secrets. For local work, use yarn build and yarn serve; yarn deploy is Docusaurus's GitHub Pages deployment command and is not the deployment path for this site.