mdbook_ai_pocket_reference/
lib.rs

1//! # `mdbook-ai-pocket-reference`
2//!
3//! This crate produces a preprocessor for the [rust-lang mdbook](https://github.com/rust-lang/mdBook)
4//! project that comprises of various link helpers for the [AI-Pocket-Reference](https://github.com/VectorInstitute/ai-pocket-reference)
5//! project.
6//!
7//! ## Basic Usage
8//!
9//! First, install the crate:
10//!
11//! ```sh
12//! cargo install mdbook-ai-pocket-reference
13//! ```
14//!
15//! Next, and as with all preprocessor extensions, to include ` mdbook-ai-pocket-reference`
16//! in your book, add the following to your `book.toml`:
17//!
18//! ```sh
19//! [preprocessor.ai-pocket-reference]
20//! command = " mdbook-ai-pocket-reference"
21//! ```
22//!
23//! In order to add an author or list of authors in your chapter, there is currently
24//! one supported helper:
25//!
26//! ```markdown
27//! <!-- for including ai-pocket-reference header (default) -->
28//! {{#aipr_header}}
29//!
30//! <!-- for including ai-pocket-reference header with colab link -->
31//! {{ #aipr_header colab=nlp/lora.ipynb}}
32//!
33//! ```
34//!
35//! For more details see the project's [README](https://github.com/VectorInstitute/mdbook-ai-pocket-reference)
36
37pub mod ai_pocket_reference;
38
39pub use ai_pocket_reference::AIPRPreprocessor;