A documentation site for Everywhere, built with Next.js and Fumadocs.
- Framework: Built on Next.js, leveraging React Server Components.
- Documentation: Powered by Fumadocs, offering a robust MDX-based documentation workflow.
- Styling: Styled with Tailwind CSS v4 and
tailwindcss-animatefor a beautiful, responsive UI. - Icons: Uses Lucide React for consistent and crisp iconography.
- Internationalization: Built-in support for multiple languages (e.g., English, Simplified Chinese).
- Search: Integrated search functionality for quick navigation.
- Core: TypeScript, React, Next.js
- Content: MDX (Fumadocs MDX)
- UI/UX: Tailwind CSS, Radix UI (via Fumadocs UI)
- Package Manager: pnpm
everywhere-website
βββ app/ # Next.js App Router (pages, layouts, API)
β βββ api/ # API routes
β βββ og/ # Open Graph image generation
β βββ [lang] # Internationalized routes
β βββ (home)/ # Landing page routes
β βββ docs/ # Documentation routes
β βββ llms-full.txt/ # Full Documentation text file
β βββ llms.mdx/ # Text file for pages
β βββ policies/ # Policy pages
βββ components/ # Reusable React components
βββ content/ # MDX content source
β βββ docs/ # Documentation files
β βββ policies/ # Policy documents
βββ lib/ # Utilities and configurations
βββ public/ # Static assets
βββ next.config.mjs # Next.js configuration
βββ open-next.config.ts # Open Next configuration
βββ source.config.ts # Fumadocs configuration
Ensure you have the following installed:
- Node.js (LTS version recommended)
- pnpm (Project package manager)
-
Clone the repository:
git clone https://github.com/Sylinko/everywhere-website.git cd everywhere-website -
Install dependencies:
pnpm install
Start the development server:
pnpm dev
Open http://localhost:3000 in your browser to see the result.
To build the application for production:
pnpm build
To start the production server:
pnpm start
We maintain high code quality standards using ESLint and Prettier.
- Lint:
pnpm lint(Checks for code issues) - Format:
pnpm format(Formats code with Prettier) - Type Check:
pnpm types:check(Runs TypeScript type checking)
Contributions are welcome! Please check the content directory to add or update documentation.
Apache 2.0 Β© Sylinko Inc.