mdbook-ai-pocket-reference

A preprocessor for mdbook specifically for AI Pocket References by Vector Insitute. It provides:

• standard header for AI Pocket References
• standard footer for AI Pocket References
• expansion of markdown links [some text](someurl.io) into html that opens the link in a new browser tab

Installation

cargo install mdbook-ai-pocket-reference

1. Download the src/bin/assets/mdbook-ai-pocket-reference.css and add to your book's root directory:

[!NOTE] If working with ai-pocket-reference collection, then this additional css file is already included, and so this step can be safely skipped.

Usage

1. Add to your book.toml:

[preprocessor.ai-pocket-reference]
command = "mdbook-ai-pocket-reference"

[output.html]
additional-css = ["mdbook-ai-pocket-reference.css"]

1. Add ai-pocket-reference header:

# Chapter Title

<!-- Default header -->
{{#aipr_header}}

<!-- Default header with colab -->
{{#aipr_header colab=nlp/lora.ipynb}}

<!-- Default header with colab and no reading time -->
{{#aipr_header colab=nlp/lora.ipynb,reading_time=false}}

The preprocessor will expand the helper to include the established header style for AI Pocket References.

Examples

# LoRA

{{#aipr_header colab=nlp/lora.ipynb}}

Low-rank adaptation (LoRA) is parameter-efficient fine-tuning (PEFT) introduced
by Hu, Edward J. et...

Will render as: