Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Sylinko/everywhere-website

Repository files navigation

Everywhere Website

A documentation site for Everywhere, built with Next.js and Fumadocs.

πŸš€ Key Features

  • 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-animate for 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.

πŸ› οΈ Tech Stack

  • Core: TypeScript, React, Next.js
  • Content: MDX (Fumadocs MDX)
  • UI/UX: Tailwind CSS, Radix UI (via Fumadocs UI)
  • Package Manager: pnpm

πŸ“‚ Project Structure

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

🏁 Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (LTS version recommended)
  • pnpm (Project package manager)

Installation

  1. Clone the repository:

    git clone https://github.com/Sylinko/everywhere-website.git
    cd everywhere-website
  2. Install dependencies:

    pnpm install

Development

Start the development server:

 pnpm dev

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

Build

To build the application for production:

 pnpm build

To start the production server:

 pnpm start

πŸ” Code Quality

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)

🀝 Contributing

Contributions are welcome! Please check the content directory to add or update documentation.

πŸ“„ License

Apache 2.0 Β© Sylinko Inc.

About

Documentation Site for Everywhere

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

Contributors

Languages

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /