mkdocs-codeinclude-plugin 0.3.1
A plugin to include code snippets into mkdocs pages
Requires Python: >=3.11
Keywords: mkdocs, python, markdown, codeinclude

# mkdocs-codeinclude-plugin

A plugin for mkdocs that allows some advanced 'includes' functionality to be used for embedded code blocks.
This is effectively an extended Markdown format, but is intended to degrade gracefully when rendered with a different renderer. 

## Installation

1. Install the plugin:

    ```
    pip install mkdocs-codeinclude-plugin
    ```

2. Add `codeinclude` to the list of your MkDocs plugins (typically listed in `mkdocs.yml`):

    ```yaml
    plugins:
      - codeinclude
    ```

3. The plugin should be configured use an appropriate form of tabbed fences, depending on the version of 
[`pymdown-extensions`](https://github.com/facelessuser/pymdown-extensions) that is installed.
Tabbed fences provide a 'title' for code blocks, and adjacent code blocks will appear as a multi-tabbed code block.

    a. For version 8.x of `pymdown-extensions`, use the following or leave blank (default):
        
    ```yaml
    plugins:
      - codeinclude:
          title_mode: pymdownx.tabbed 
    ```
   
   b. For version 7.x or lower of `pymdown-extensions`, use the following:
   
   ```yaml
   plugins:
     - codeinclude:
         title_mode: legacy_pymdownx.superfences
   ```
   
   c. If you are using [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-a-title), use the following:
   
   ```yaml
    plugins:
      - codeinclude:
            title_mode: mkdocs-material
   ```
   
   d. If no tabbed fences should be used at all:
   
   ```yaml
   plugins:
     - codeinclude:
         title_mode: none
   ```

## Usage

A codeinclude block resembles a regular markdown link surrounded by a pair of XML comments, e.g.:

<!-- 
To prevent this from being rendered as a codeinclude when rendering this page, we use HTML tags.
See this in its rendered form to understand its actual appearance, or look at other pages in the
docs.
-->

<pre><code>&lt;!--codeinclude--&gt;
[Human readable title for snippet](./relative_path_to_example_code.java) targeting_expression
&lt;!--/codeinclude--&gt;
</code></pre>

Where `targeting_expression` could be:

* `block:someString` or
* `inside_block:someString`

If these are provided, the macro will seek out any line containing the token `someString` and grab the next curly brace
delimited block that it finds. `block` will grab the starting line and closing brace, whereas `inside_block` will omit 
these. If no `targeting_expression` is provided, the whole file is included.

e.g., given:
```java

public class FooService {

    public void doFoo() {
        foo.doSomething();
    }

}
```

If we use `block:doFoo` as our targeting expression, we will have the following content included into our page:

```java
public void doFoo() {
    foo.doSomething();
}
```

Whereas using `inside_block:doFoo` we would just have the inner content of the method included:

```java
foo.doSomething();
```

Note that:

* Any code included will be have its indentation reduced
* Every line in the source file will be searched for an instance of the token (e.g. `doFoo`). If more than one line
  includes that token, then potentially more than one block could be targeted for inclusion. It is advisable to use a
  specific, unique token to avoid unexpected behaviour.
* If the specified block is not found, behavior depends on the `block_throw` config value (see [Configuration](#configuration))
  
When we wish to include a section of code that does not naturally appear within braces, we can simply insert our token,
with matching braces, in a comment. 
While a little ugly, this has the benefit of working in any context, even in languages that do not use
curly braces, and is easy to understand. 
For example:

```java
public class FooService {

    public void boringMethod() {
        doSomethingBoring();
        
        // doFoo {
        doTheThingThatWeActuallyWantToShow();
        // }
    }

}
```

will be rendered as:

```java
doTheThingThatWeActuallyWantToShow();
```

## Configuration

This plugin takes two config values, specified in `mkdocs.yml`.

| Name          | Description                                                                                                         | Values                                                   | Default           |
|---------------|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|-------------------|
| `title_mode`  | Controls how titles are generated for included blocks                                                               | `none`, `legacy_pymdownx.superfences`, `pymdownx.tabbed` | `pymdownx.tabbed` |
| `block_throw` | Controls whether to include entire file (`false`) or raise an error (`true`) if included block is not found in file | `true`, `false`                                          | `false`           |


## Building the Project

Install the dependencies:

```shell
pip install -r requirements.txt
pip install pytest # install pytest to run the tests
```

### Running tests

To run the tests:
```shell
pytest
```

### Formatting code

Code is formatted with Black. To apply formatting:
```shell
black codeinclude tests
```