# cargo-mdbook

**Repository Path**: hello_wxs/cargo-mdbook

## Basic Information

- **Project Name**: cargo-mdbook
- **Description**: A simple bin to exprot mdbook.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://codeberg.org/hello_wxs/cargo-mdbook
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-20
- **Last Updated**: 2026-07-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

# cargo-mdbook
**A tool for build-in mdbook in cargo**

[![Version](https://img.shields.io/crates/v/cargo-mdbook)](https://crates.io/crates/cargo-mdbook)
[![Downloads](https://img.shields.io/crates/d/cargo-mdbook)](https://crates.io/crates/cargo-mdbook)
[![License](https://img.shields.io/crates/l/cargo-mdbook)](https://codeberg.org/hello_wxs/cargo-mdbook/src/branch/main/LICENSE.md)
[![Author](https://img.shields.io/badge/author-hello_wxs-white.svg)](https://codeberg.org/hello_wxs)

[en](https://codeberg.org/hello_wxs/cargo-mdbook/src/branch/main/README.md) | [简体中文]([README-zh_cn.md](https://codeberg.org/hello_wxs/cargo-mdbook/src/branch/main/README-zh_cn.md))
</div>

With this tool, you can use `mdbook` in your cargo projects.
> Notes:
>
> Before using this tool, make sure you have `mdbook` installed.
> If you don't have `mdbook` installed, you can install it by using this:
> ```shell
> cargo install mdbook
> ```

## Why use this tool instead of using `mdbook` directly?

If you have a large number of `mdbook` projects, using this tool can help you manage them more easily.
You can write metadata in a `mdbook.toml` file and use this tool to build your book.
Like this config (optional):
```toml
[package.metadata.mdbook]
targets = [
    "docs/en",
    "docs/zh_cn"
]
```
```toml
[workspace.metadata.mdbook]
targets = [
    "docs/en",
    "docs/zh_cn"
]
```
Then, use this command to build your book:
```shell
cargo mdbook build
```

## Usage
```txt
cargo-mdbook - A tool for building and testing mdbook books in cargo

Usage: cargo-mdbook COMMAND ...

Available options:
    -h, --help     Prints help information
    -V, --version  Prints version information

Available commands:
    build          Builds book(s) from its markdown files
    test           Tests that book(s)'s Rust code samples compile
    clean          Deletes built book(s)
    watch          Watches book(s)'s files and rebuilds it on changes
    serve          Serves book(s), and rebuilds it on changes
```