Linx Documentation Platform

Welcome to the Linx Documentation Platform (Linx Books), a high-performance, developer-focused documentation engine. Built on React, TypeScript, Vite, and Tailwind CSS, Linx Books renders raw Markdown files into a premium, interactive reading experience with a modern aesthetic.

Key Features

Linx Books comes equipped with standard-setting features for publishing technical reference documents:

• File-System Based Routing: No manual routing configurations. The folder structure of your /content/ directory dictates the URLs and navigation.
• Premium Cover Banners: Custom local or remote images act as decorative page covers. Fully responsive (16:9 mobile, 21:9 desktop) and constrained to avoid overpowering layouts.
• Structured Thumbnails: Customize icons and images for sidebar files and folders with whitelisted Lucide keys or local/remote URLs.
• Dynamic Table of Contents: Automatically extracts heading anchors (H1, H2, H3) and tracks your scroll position to highlight the active section.
• Embedded UI Components: Render live interactive components (badges, callout alerts, copier buttons, tabs, accordions) using fenced markdown code blocks.
• Next/Prev Navigation: Built-in sibling navigation scoped within the active document group to help users read sequentially.

Directory Layout Overview

To add books or documentation pages, simply organize your files under the /content/ directory.

Next Steps

To explore how to customize and structure your documentation books, check out the specific guides below:

1. Routing & Directory Structure: Understand how nested subfolders and category files define URLs.
2. Configuration & Metadata: Customize frontmatter properties, thumbnails, and page banners.
3. Interactive UI Components: Learn how to embed live alerts, buttons, command blocks, and cards directly inside Markdown.