include_md 0.2.1

Include markdown file or its section.
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


# Module :: include_md
<!--{ generate.module_header.start() }-->
 [![experimental](https://raster.shields.io/static/v1?label=&message=experimental&color=orange)](https://github.com/emersion/stability-badges#experimental) [![rust-status](https://img.shields.io/github/actions/workflow/status/Wandalen/wTools/workspace_push.yml?label=&branch=master&job=include_md)](https://github.com/Wandalen/wTools/actions/workflows/workspace_push.yml) [![docs.rs](https://img.shields.io/docsrs/include_md?color=e3e8f0&logo=docs.rs)](https://docs.rs/include_md) [![discord](https://img.shields.io/discord/872391416519737405?color=eee&logo=discord&logoColor=eee&label=ask)](https://discord.gg/m3YfbXpUUY)
<!--{ generate.module_header.end }-->

Include markdown file or its section.

### To add to your project

```shell
cargo add include_md
```

## Quick Start

Include a complete markdown file as a compile-time string constant:

```rust
let content = include_md::include_md!( "../readme.md" );
println!( "{content}" );
```

Include only a named section from a markdown file:

```rust
let section = include_md::include_md_section!( "readme.md", "## Quick Start" );
println!( "{section}" );
```

Paths for `include_md!` resolve relative to the source file (same as `include_str!`).
Paths for `include_md_section!` resolve relative to `CARGO_MANIFEST_DIR` (crate root).
Both macros reject files larger than 10 MB at compile time.