Skip to content

README.md

Latest commit

 

History

History
68 lines (46 loc) · 2.41 KB

README.md

File metadata and controls

68 lines (46 loc) · 2.41 KB
Raw

Fiber Documentation

Welcome to the Fiber documentation repository! This contains the official documentation for the Fiber project, built with Fumadocs.

Getting Started

pnpm install
pnpm dev

Open http://localhost:3000 with your browser to see the result.

Environment Variables

For production deployment, you'll need to set up the following environment variables:

Required for Devlog Functionality

# GitHub Personal Access Token for fetching devlog discussions
# Create at: https://github.com/settings/tokens
# Required scopes: 'public_repo'
GITHUB_TOKEN=your_github_personal_access_token_here

Google Analytics (optional)

Set the GA4 measurement ID in the production deployment environment to enable site-wide page-view and user analytics. When the variable is unset, no Google Analytics script is loaded.

NEXT_PUBLIC_GA_MEASUREMENT_ID=G-XXXXXXXXXX

In the GA4 web data stream, keep Enhanced measurement enabled and make sure both page loads and browser-history page changes are tracked. This records client-side navigation in the Next.js app without custom page-view events.

Explore

In the project, you can see:

  • lib/source.ts: Code for content source adapter, loader() provides the interface to access your content.
  • app/layout.config.tsx: Shared options for layouts, optional but preferred to keep.
Route Description
app/(home) The route group for your landing page and other pages.
app/docs The documentation layout and pages.
app/api/search/route.ts The Route Handler for search.

Fumadocs MDX

A source.config.ts config file has been included, you can customise different options like frontmatter schema.

Read the Introduction for further details.

Learn More

To learn more about Next.js and Fumadocs, take a look at the following resources: