Plugin for MkDocs helping with rendering Entangled (entangled.github.io) projects.
Project description
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
:
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
``` {.python file=hello_world.py}
if __name__ == "__main__":
<<hello-world>>
```
Which renders like this:
if __name__ == "__main__":
<<hello-world>>
Or named code blocks
``` {.python #hello-world}
print("Hello, World!")
```
that render like this:
print("Hello, World!")
Build Artifacts
Build artifacts by specifying a Makefile.
=== "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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_entangled_plugin-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f585cc5811fb097aad0435c20929108348b293830e4b8978b55e19f24631908 |
|
MD5 | d0e6d62cad67993a5d6ac6668e88afcc |
|
BLAKE2b-256 | 9ba2f94a86faae15f76daf39735f4aed443a9fb5af5e568919f9d472cbc222b5 |
Close
Hashes for mkdocs_entangled_plugin-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f386631c11e6c19a41f89902f83275c274db8abacf5adac9cff88394ec9e1788 |
|
MD5 | 6169a2b84340402ef14f6ebf9c83513f |
|
BLAKE2b-256 | 0a89c75092d147093ccf6994bacddd58b40d3fa92092d9ec236356f399a4d44a |