Metadata-Version: 2.1
Name: mkdocs-entangled-plugin
Version: 0.2.0
Summary: Plugin for MkDocs helping with rendering Entangled (entangled.github.io) projects.
License: Apache 2.0
Author: Johan Hidding
Author-email: j.hidding@esciencecenter.nl
Requires-Python: >=3.7
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: mkdocs (>=1.4.2,<2.0.0)
Description-Content-Type: text/markdown

# Welcome to MkDocs Entangled Plugin
Using this plugin, you can make your Entangled documents look better.

## Install

Install this with `pip install mkdocs-entangled-plugin`. To use the entangled plugin, add the following lines to your `mkdocs.yml`:

```yaml
plugins:
  - entangled

markdown_extensions:
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
```

## Annotates codeblocks
The default markdown syntax that Entangled supports has fenced code blocks as follows

~~~markdown
``` {.python file=hello_world.py}
if __name__ == "__main__":
    <<hello-world>>
```
~~~

Which renders like this:

``` {.python file=hello_world.py}
if __name__ == "__main__":
    <<hello-world>>
```

Or named code blocks

~~~markdown
``` {.python #hello-world}
print("Hello, World!")
```
~~~

that render like this:

``` {.python #hello-world}
print("Hello, World!")
```

## Build Artifacts

Build artifacts by specifying a Makefile.

~~~markdown
=== "Figure 1"

    ![](fig/plot.svg)

=== "Makefile"

    ``` {.make .build-artifact}
    .RECIPEPREFIX = >
  
    docs/fig/plot.svg:
    > mkdir -p $(@D)
    > gnuplot -e "set term svg; plot sin(x)" > $@
    ```
~~~

=== "Figure 1"

    ![](fig/plot.svg)

=== "Makefile"

    ``` {.make .build-artifact}
    .RECIPEPREFIX = >
  
    docs/fig/plot.svg:
    > mkdir -p $(@D)
    > gnuplot -e "set term svg; plot sin(x)" > $@
    ```

## License
Licensed under the Apache-2 license agreement: see LICENSE

