Novon Documentation

The high-performance, high-fidelity documentation engine for the Novon ecosystem.

Table of Contents

• Overview
• Core Features
• Technology Stack
• Project Structure
• Getting Started
• Content Management
• License

---

Overview

This repository contains the source code for the official Novon Documentation website. Built with Next.js 15 and MDX, it provides a lightning-fast, highly readable experience for developers and users alike.

Note

A Note from the Author: Since English is not my first language, I utilize AI agents to help maintain and refine this documentation. This collaboration allows me to document new features and architectural changes much faster and more effectively, ensuring the information remains clear, professional, and up-to-date for everyone.

This site features a premium obsidian-toned dark mode with high-contrast typography, subtle glassmorphism, and smooth interactive transitions.

Core Features

• High-Fidelity Obsidian Theme: A custom-built CSS design system inspired by modern dark-mode aesthetics.
• Weighted Fuzzy Search: A custom-built search engine (src/lib/docs-search.ts) with typo tolerance and relevance scoring.
• Global Shortcuts: Seamless navigation with Ctrl + K (Search) and full keyboard accessibility.
• Static-First Architecture: Powered by MDX for rich content with zero runtime overhead in production.
• Code Purification: A 100% comment-free production codebase for maximum clarity and minimized footprint.

Technology Stack

• Framework: Next.js 15+ (App Router)

• Logic: React 19 / TypeScript

• Styling: Pure CSS (Modern Variables & Custom Design System)

• Icons: Lucide React

• Syntax Highlighting: Shiki (GitHub Dark Dimmed)

• Markdown: next-mdx-remote

Project Structure

src/
├── app/              # Next.js App Router (Layouts, Docs Pages, Global Styles)
├── components/       # UI Components (Header, SearchModal, Sidebar, MDX)
├── content/          # Source MDX documentation files
│   └── docs/         # Hierarchical guides, API refs, and FAQs
├── lib/              # Core logic (Docs processing, Fuzzy search engine)
└── public/           # Static assets (Logos, App Mockups)

Getting Started

Prerequisites

• Node.js 20+
• npm / pnpm / yarn

Installation

# Clone the repository and navigate to docs
cd docs

# Install dependencies
npm install

Development

# Start the development server
npm run dev

The site will be available at http://localhost:3000.

Build

# Generate the production bundle
npm run build

Content Management

Adding documentation is as simple as creating a new .mdx file in src/content/docs.

1. Create your file (e.g., src/content/docs/guides/new-feature.mdx).
2. Add the required Frontmatter:

   ---
   title: New Feature
   description: A description of the new feature.
   ---

3. Update src/lib/docs-data.ts to include the relative path in the Sidebar configuration.

License

Licensed under the Apache License 2.0. See LICENSE for full details.