OSS Wiki

OSS Wiki is an open-source, collaborative documentation platform built with Next.js and Fumadocs. It empowers communities to create, manage, and share high-quality technical documentation with ease. OSS Wiki is designed for open-source projects, teams, and knowledge bases that value transparency, contribution, and modern web standards.

Features

• Modern Documentation Engine: Powered by Next.js and Fumadocs, supporting fast, SEO-friendly, and interactive docs.
• MDX Support: Write documentation in Markdown with React components for rich, dynamic content.
• Full-Text Search: Built-in search API for instant, relevant results.
• Customizable Layouts: Easily adapt the look and feel to your project's branding.
• Open Contribution Model: Simple, transparent contribution workflow for all users.
• Type-Safe Content: Uses Zod schemas for frontmatter and metadata validation.

Project Structure

• app/ — Next.js app directory (routes, layouts, API, docs, etc.)
• lib/ — Shared logic, content source adapters, and layout utilities
• components/ — UI components and documentation widgets
• content/ — MDX documentation files
• source.config.ts — Fumadocs/MDX configuration and schema definitions

Key Routes

Route	Description
/	Home/Landing page
/docs	Main documentation hub
/api/search	Search API endpoint
/og/docs/[...slug]	Open Graph image generation for docs

Getting Started

Prerequisites

• Node.js (v18+ recommended)
• bun (preferred), or npm / yarn

Installation

Clone the repository:

git clone https://github.com/Grenish/oss-wiki.git
cd oss-wiki

Install dependencies (using bun is recommended):

bun install
# or
npm install
# or
yarn install

Running the Development Server

bun dev
# or
npm run dev
# or
yarn dev

Visit http://localhost:3000 to view the app.

Contribution Guide

We welcome contributions of all kinds! Please see CONTRIBUTIONS.md for detailed guidelines on how to get involved, report bugs, suggest features, and submit pull requests.

Quick Contribution Steps

1. Fork and clone the repository
2. Create a new branch for your feature or fix
3. Make your changes and commit with a descriptive message
4. Push your branch and open a Pull Request

Configuration & Customization

• Content Source: Edit lib/source.ts and source.config.ts to customize content loading and schema.
• Layouts: Adjust layouts in lib/layout.shared.tsx and app/docs/layout.tsx.
• UI Components: Update or add components in components/ as needed.
• Styling: Modify app/global.css and use Tailwind CSS for utility-first styling.

License

OSS Wiki is MIT licensed.

---

Made with ❤️ by the OSS Wiki community.