mdbook-lint 0.2.0

A fast markdown linter for mdBook
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# Installation

mdbook-lint can be installed through several methods depending on your needs.

## From Crates.io (Recommended)

The easiest way to install mdbook-lint is through Cargo:

```bash
cargo install mdbook-lint
```

This will install the latest stable version from [crates.io](https://crates.io/crates/mdbook-lint).

## From Source

To install the latest development version or contribute to the project:

```bash
git clone https://github.com/joshrotenberg/mdbook-lint.git
cd mdbook-lint
cargo install --path .
```

## Pre-built Binaries

Pre-built binaries for common platforms are available on the [GitHub releases page](https://github.com/joshrotenberg/mdbook-lint/releases).

Download the appropriate binary for your platform and add it to your PATH.

## Requirements

- Rust 1.88 or later (if building from source)
- No runtime dependencies required

## Verification

After installation, verify that mdbook-lint is working correctly:

```bash
mdbook-lint --version
```

You should see output similar to:
```
mdbook-lint 0.1.0
```

## Next Steps

Once installed, head to the [Getting Started](./getting-started.md) guide to learn how to use mdbook-lint with your projects.