include-utils 0.1.0

mdBook-like include macro as the powerful replacement for the standard `include_str` macro.
Documentation

Include utils

A more powerful replacement for the standard inlcude_str macros.

Often you only need a specific part of the file, e.g. relevant lines for an example, or section of README.md. This crate provides macros that can include only part of a file, similar to the mdbook specific feature.

Imagine that you want to include "usage" section from your repository readme file to the crate documentation. But you do not want to see in crate documentation some parts of readme file, like header, badges, etc. With the include_str macro you can only include the entire file content.

But with the [include_md] macro you can include only a specific section of the file.

Note! Unlike the built-in macro, this macros uses the CARGO_MANIFEST_DIR as the current directory instead of the directory from which macro is called.

Usage

//! # Crate overview
//! 
#![doc = include_utils::include_md!("README.md:description")]
//!
//! ## Other section