Litho Book

English | 中文

🛠️ A high-performance markdown reader built with Rust and Axum

📚 Modern web reading experience for documents generated by Litho (deepwiki-rs)

🚀 If you like this project, please give it a ⭐ and consider supporting the development of Litho project!

👋 What's Litho Book

Litho Book is a modern markdown reader specifically designed for the Litho (deepwiki-rs) documentation generation engine. It provides an elegant interface and powerful features that allow you to easily browse and read project architecture documentation generated by Litho.

Litho Book is completely free and open-source, built with a high-performance Rust technology stack to provide you with a smooth documentation reading experience.

❤️ Like Litho Book? Star it 🌟 and learn more about the Litho project! ❤️

🌠 Snapshots

🌟 Key Features

• 📖 Real-time Rendering - Right panel renders markdown content in real-time with syntax highlighting and formatting
• 📊 Mermaid Chart Support - Perfect support for various Mermaid chart rendering, bringing architecture diagrams to life
• 🔍 Intelligent Search - Quick search for document files with fuzzy matching for filenames and paths
• 🤖 AI Companion - AI Intelligent Document Interpretation, Answering Questions
• 🔤 Smart Sorting - Directories and files are automatically sorted by name for quick content discovery
• ⚡ High-Performance Architecture - Built with Rust and Axum for low memory usage and fast response times
• 🎨 Modern UI - Clean and beautiful user interface with clear information hierarchy and elegant interactions

🧠 How it Works

Litho Book serves as an important component of the Litho (deepwiki-rs) ecosystem, focusing on providing excellent documentation reading experience:

graph LR
    subgraph "Litho Ecosystem"
        A[Project Code] --> B[Litho Engine]
        B --> C[Generated Docs]
        C --> D[Litho Book]
        D --> E[Elegant Reading Experience]
    end

1. Document Scanning: Scans all markdown documentation files in the specified directory
2. Structure Building: Builds hierarchical document directory tree structure
3. Content Rendering: Real-time rendering of markdown content with syntax highlighting and Mermaid charts
4. Interactive Experience: Provides search, navigation and other interactive features to improve reading efficiency

🖥️ Getting Started

Prerequisites

• Rust (version 1.70 or later)
• Cargo

Installation

1. Clone the repository

   git clone <repository-url>
   cd litho-book
   

2. Build the project

   cargo build --release
   

3. The compiled binary will be available in the target/release directory

🚀 Usage

Litho Book provides a clean command-line interface to quickly start the documentation server:

Basic Commands

# Basic usage - specify documentation directory
cargo run -- --docs-dir ./sample-markdowns-docdir

# Specify port and auto-open browser
cargo run -- --docs-dir ./docs --port 8080 --open

# Enable verbose logging
cargo run -- --docs-dir ./docs --verbose

Using with Litho

# 1. Generate project documentation with Litho
litho --project ./my-project --output ./docs

# 2. Read the generated documentation with Litho Book
cargo run -- --docs-dir ./docs --open

Command Line Arguments

🏗️ Technical Architecture

Litho Book adopts a modern Rust technology stack to ensure high performance and reliability:

Core Technology Stack

• CLI Framework: clap - Powerful command-line argument parsing and validation
• Web Framework: axum - High-performance async web framework with modern HTTP features
• Template Engine: askama - Compile-time template engine with zero runtime overhead
• Markdown Rendering: pulldown-cmark - High-performance Markdown parser, fully CommonMark compatible
• Async Runtime: tokio - The most mature async runtime in the Rust ecosystem
• Serialization: serde - Efficient data serialization and deserialization

System Architecture Diagram

flowchart TB
    subgraph "CLI Layer"
        A[Argument Parsing]
        B[Config Validation]
        C[Service Startup]
    end

    subgraph "Web Server Layer"
        D[Axum Routing]
        E[Static File Service]
        F[API Endpoints]
        G[Middleware]
    end

    subgraph "Frontend Layer"
        H[Directory Tree Component]
        I[Markdown Rendering]
        J[Mermaid Charts]
        K[Search Functionality]
    end

    subgraph "Data Layer"
        L[File System]
        M[Directory Scanning]
        N[File Reading]
        O[Tree Structure Building]
    end

    A --> D
    B --> D
    C --> D
    D --> H
    E --> I
    F --> J
    G --> K
    D --> L
    L --> M
    M --> N
    N --> O

♻️ Execution Workflow

sequenceDiagram
participant Developer as Developer
participant Litho as Litho Engine
participant LithoBook as Litho Book
participant Browser as Browser
Developer->>Litho : litho --project ./my-project --output ./docs
Litho-->>Developer : Documentation generation completed
Developer->>LithoBook : cargo run -- --docs-dir ./docs --open
LithoBook-->>Developer : Server started successfully
LithoBook->>Browser : Automatically opens http://127.0.0.1:3000
Browser->>LithoBook : Requests main page
LithoBook-->>Browser : Returns HTML page
Browser->>LithoBook : Requests document tree (/api/tree)
LithoBook-->>Browser : Returns JSON-formatted tree structure
Browser->>LithoBook : Requests file content (/api/file?file=...)
LithoBook-->>Browser : Returns rendered HTML content

📦 Core Components

• CLI Handler: Responsible for command-line argument parsing, configuration validation, and server startup
• Web Server: High-performance HTTP server based on Axum, providing API and static file services
• Documentation Engine: Core logic for handling document scanning, parsing, and rendering
• Frontend Interface: Responsive web interface providing intuitive document browsing experience

📁 Project Structure

litho-book/
├── src/
│   ├── main.rs              # Main program entry and server startup
│   ├── cli.rs               # CLI argument processing and configuration management
│   ├── filesystem.rs        # File system operations and directory scanning
│   ├── server.rs            # Web server and routing configuration
│   └── error.rs             # Error handling and type definitions
├── templates/
│   └── index.html.tpl           # Main page template (Askama)
├── static/                  # Static resource files
│   ├── css/                 # Style files
│   ├── js/                  # JavaScript files
│   └── assets/              # Images and other resources
├── sample-markdowns-docdir/ # Sample documentation directory
├── Cargo.toml               # Project configuration and dependencies
├── Cargo.lock               # Dependency version lock
└── README.md                # Project documentation

🧩 API Interface Documentation

Litho Book provides the following API endpoints to support dynamic frontend functionality:

🔧 Development Guide

Development Environment Requirements

• Rust: Version 1.70 or higher
• Cargo: Rust package manager
• Git: Version control tool

Local Development

# Clone the project
git clone <repository-url>
cd litho-book

# Run development version
cargo run -- --docs-dir ./sample-markdowns-docdir --verbose

# Run test suite
cargo test

# Code quality check
cargo clippy

# Code formatting
cargo fmt

# Build release version
cargo build --release

API Documentation

📝 Usage Examples

Complete Workflow

# 1. Generate project documentation with Litho
git clone https://github.com/sopaco/deepwiki-rs.git
cd deepwiki-rs
cargo build --release
./target/release/litho --project ./my-project --output ./project-docs

# 2. Read documentation with Litho Book
git clone <litho-book-repository>
cd litho-book
cargo run -- --docs-dir ./project-docs --open

Starting the Server

# Use default settings
cargo run -- -d ./docs

# Custom port and auto-open browser
cargo run -- -d ./docs -p 8080 -o

# Bind to all network interfaces (for team sharing)
cargo run -- -d ./docs --host 0.0.0.0 -p 3000

# Enable verbose logging (for debugging)
cargo run -- -d ./docs --verbose

Access and Usage

1. Start Service: After running the command, visit the displayed URL (default: http://127.0.0.1:3000)
2. Browse Documents: Left directory tree shows all markdown files with hierarchical expansion support
3. View Content: Click file names to view rendered content on the right side
4. Quick Search: Use the top search box to quickly find files and content
5. Chart Support: Mermaid charts are automatically rendered, supporting various chart types
6. Responsive Experience: Get excellent reading experience on different devices

🤝 Contributing

We welcome all forms of contributions! Report bugs or submit feature requests through GitHub Issues.

Ways to Contribute

• Feature Enhancement: Implement new document reading features and interactive experiences
• Performance Optimization: Improve document loading speed and rendering performance
• Interface Improvement: Optimize user interface design and user experience
• Documentation: Improve project documentation and usage guides
• Test Coverage: Add test cases to improve code quality
• Internationalization: Support multi-language interface and documentation

Development Contribution Process

1. Fork this project
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Create a Pull Request

⚛️ Built With

• Rust - Systems programming language
• Axum - Modern async web framework
• Tokio - Async runtime
• Askama - Compile-time template engine
• Clap - Command line argument parser
• Serde - Serialization framework
• pulldown-cmark - Markdown parser

🪪 License

MIT. A copy of the license is provided in the LICENSE file.

🙏 Acknowledgments & Related Projects

• Litho (deepwiki-rs) - Powerful AI-driven documentation generation engine
• Axum - High-performance async web framework
• Mermaid - Excellent chart rendering library
• pulldown-cmark - High-performance Markdown parser
• Tokio - Foundation of Rust async ecosystem

💡 Recommendation: If you need to automatically generate project architecture documentation, try Litho (deepwiki-rs) - an AI-based intelligent documentation generation engine that can automatically analyze your project and generate professional C4 architecture documentation!

🚀 Explore More Excellent Open Source Projects
Litho (deepwiki-rs) • Saga Reader Mermaid Fixer