Anchors Aweigh

A versatile source inclusion plugin for the mdBook build system using treesitter queries and handlebars.

Forward

While working with mdBook I fell in love with the include tag to tie different pieces of source together in order to keep my documentation up to date. After using it for some time I started wishing it could have just a bit more functionality. For a time I was using a cocktail of really great preprocessors to help pick up the slack. I then reached a point to where I knew a better tool was needed.

I have a goal to combine many of the great "include" plugins together under one umbrella. This is because I wanted to add new kind of "Anchor" that can select sections of source code. While the ANCHOR and ANCHOR_END tags are great I wanted to be able to use treesitter queries. This is where this project starts but I hope it's not where it ends!

Example

In this example we'll create a treesitter query to select the source code of a ruby class by name and any optional comments directly above it. Add the following lines in your book.toml configuration file:

[preprocessor.anchors-aweigh]
[preprocessor.anchors-aweigh.queries.ruby]
class = """
(
  (
    (comment)*
    .
    (class name: (constant) @name (#eq? @name "{{name}}"))
  ) @match
)
"""

If you don't understand treesitter queries I highly recommend learning how to read and write them. They are incredibly handy for analyzing and working with source code. What is important to know for this example is it will match a class with a name and any number of optional comments right above it. The handlebars style of name becomes a binding we pass in as anchor parameters.

In a markdown document the following example would then pull in the lines matched by that query:

{{#aa file.rb#class?name=Widget}}

mdBook Compatibility

If you are using mdBook version 0.4.x please use version 0.2.x of this plugin. Version 0.3.x and up of this plugin requires mdBook 0.5.x or newer.

Installing

From Source

1. Clone the repo

   git clone https://github.com/benfalk/anchors-aweigh.git

2. Compile & Install with Cargo

   cargo install --path=crates/mdbook_anchors_aweigh

With Cargo

cargo install mdbook-anchors-aweigh

With Cargo Binstall

cargo-binstall mdbook-anchors-aweigh

---