mirror of
https://github.com/LibreChat-AI/librechat.ai.git
synced 2026-03-27 10:48:32 +07:00
04547d128a
- Delete entire pages/ directory and Nextra compatibility shims (lib/nextra-shims/, theme.config.tsx) - Migrate toolkit, subscribe, and unsubscribe routes to app/ router with proper server/client component split - Remove Nextra webpack aliases, _meta loader, and pages/ MDX include from next.config.mjs - Replace Nextra MDX provider with minimal lib/mdx-provider.ts for components/ directory MDX files - Add redirects for old toolkit URLs (yaml_checker → yaml-checker, creds_generator → creds-generator) - Upgrade ESLint 8→9 with ESLINT_USE_FLAT_CONFIG=false for legacy config compatibility - Remove unused devDependencies: eslint-plugin-mdx, eslint-plugin-tailwindcss - Upgrade eslint-config-prettier, eslint-plugin-prettier, eslint-plugin-react, eslint-plugin-unicorn - Clean up .eslintrc.cjs: remove dead Nextra/packages override blocks, fix React rules file pattern - Delete unused components: Author/*, blog/BlogCard, blog/BlogHeader, home/Changelog, policies - Fix lint errors: remove unused React imports, rename .tsx→.ts where no JSX, useMemo([])→useRef().current https://claude.ai/code/session_01YKUFdMxJkWudwuKyTQHqDB
LibreChat Docs
The official documentation site for LibreChat, built with Next.js 15 and Fumadocs.
Tech Stack
- Framework: Next.js 15 (App Router)
- Docs Engine: Fumadocs (fumadocs-mdx + fumadocs-ui)
- Styling: Tailwind CSS
- Icons: Lucide React
- Package Manager: Bun
Local Development
Prerequisites: Bun 1.0+
- Clone the repository
- Copy
.env.templateto.env.localand fill in any optional values - Install dependencies:
bun i - Start the dev server (uses Turbopack):
bun dev - Open http://localhost:3333
Note: Always run bun run build before opening a PR to catch build errors early.
Project Structure
app/ # Next.js App Router pages (docs, blog, changelog, API routes)
content/
docs/ # Documentation pages (MDX)
blog/ # Blog posts (MDX)
changelog/ # Changelog entries (MDX)
components/ # React components (home, UI, icons, etc.)
lib/ # Utilities, icons, MDX components, Nextra shims
public/ # Static assets
pages/ # Legacy pages (migrating to app/)
source.config.ts # Fumadocs content collections config
Documentation Content
Docs live in content/docs/ and are organized by section. Each directory has a meta.json that controls sidebar navigation:
{
"title": "Section Title",
"icon": "Wrench",
"pages": ["index", "page-one", "page-two"]
}
Only pages listed in the pages array appear in the sidebar.
Scripts
| Command | Description |
|---|---|
bun dev |
Start dev server on port 3333 (Turbopack) |
bun run build |
Production build |
bun start |
Start production server on port 3333 |
bun run lint |
Run ESLint |
bun run prettier |
Format code with Prettier |
bun run analyze |
Analyze production bundle size |