Skip to content

Releases: terraphim/md-book

md-book v0.1.0 - Initial Release

18 Oct 21:32
25e38a4

Choose a tag to compare

🎉 Initial Release of md-book

A modern mdbook replacement written in Rust that generates beautiful HTML documentation from Markdown files.

✨ Key Features

  • Modern HTML Generation: Beautiful, responsive documentation sites
  • Multiple Markdown Support: Markdown, GFM, and MDX formats
  • Syntax Highlighting: Server-side code highlighting with multiple themes
  • Built-in Search: Integrated Pagefind search engine with real-time results
  • Live Development: File watching and live reload development server
  • Math Support: Mathematical notation rendering (configurable)
  • WASM Compatible: Can compile to WebAssembly for browser usage
  • Fast Performance: Rust-powered performance and reliability

🚀 What's New

  • Complete markdown to HTML conversion pipeline
  • Tera-based templating system with customizable themes
  • Responsive design with modern CSS framework
  • Comprehensive search functionality with highlighting
  • Development server with WebSocket live reload
  • Extensive configuration options via TOML/JSON/YAML
  • Full test coverage with unit, integration, and e2e tests
  • Playwright-verified UI functionality

🛠️ Installation

cargo install md-book

📖 Quick Start

# Basic usage
md-book -i input_dir -o output_dir

# Development mode
md-book -i input_dir -o output_dir --watch --serve

🧪 Testing

This release has been thoroughly tested with:

  • 52 passing tests (29 unit + 23 integration/e2e)
  • Playwright browser automation verification
  • Multiple platform compatibility (Linux, macOS, Windows)
  • WASM compilation verification

📚 Documentation

Full documentation available at: https://md-book.pages.dev

🤝 Contributing

Contributions welcome! See the CONTRIBUTING.md for details.


Built with ❤️ in Rust