📖 Wiki Engine

A modern, lightning-fast, and highly responsive documentation and wiki engine built with React, Vite, and Tailwind CSS. Designed with a focus on typography, readability, and a frictionless user experience.

✨ Features

• 🎨 Ultra-Clean Typography: A minimal, distraction-free reading experience that puts your content first.
• 🌓 Seamless Dark Mode: First-class dark mode support featuring a sophisticated deep zinc (#09090b) theme, automatically syncing with system preferences.
• 🔍 Lightning-Fast Search: Integrated ⌘K command palette powered by FlexSearch for instant, full-text documentation discovery.
• 📱 Fully Responsive: A carefully crafted mobile experience with an off-canvas sidebar and optimized touch targets.
• 🗺️ Dynamic Navigation: Auto-generated sidebar trees and dynamic on-page Table of Contents for effortless browsing.
• ⚡ Built for Speed: Powered by Vite and React 18 for instant HMR and optimized production builds.

🚀 Getting Started

Prerequisites

Ensure you have Node.js (v18 or higher) installed.

Installation

1. Clone the repository and navigate to the project directory:

   git clone <repository-url>
   cd wiki-engine

2. Install the dependencies:

   npm install

3. Start the development server:

   npm run dev

4. Open your browser and navigate to http://localhost:3000.

🛠️ Tech Stack

• Framework: React 18
• Build Tool: Vite
• Styling: Tailwind CSS
• Routing: React Router
• Animations: Motion
• Search: FlexSearch
• Icons: Lucide React

📁 Project Structure

src/
├── components/     # Reusable UI components (Layout, Sidebar, Search)
├── lib/            # Utilities, content parsing, and search logic
├── pages/          # Route components (WikiPage, Home)
├── content/        # Markdown files serving as the wiki source
├── App.tsx         # Main application routing
└── main.tsx        # React entry point

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

This project is licensed under the MIT License.