{"id":29723374,"url":"https://github.com/entangled/mkdocs-plugin","last_synced_at":"2026-05-19T05:40:04.044Z","repository":{"id":152561437,"uuid":"626431383","full_name":"entangled/mkdocs-plugin","owner":"entangled","description":"An MkDocs plugin that lets you do Literate Programming through Entangled.","archived":false,"fork":false,"pushed_at":"2023-10-14T12:19:27.000Z","size":147,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-13T17:22:48.178Z","etag":null,"topics":["literate-programming","markdown","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://entangled.github.io/mkdocs-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/entangled.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-04-11T13:06:53.000Z","updated_at":"2024-09-06T10:00:06.000Z","dependencies_parsed_at":"2023-10-15T12:30:19.946Z","dependency_job_id":null,"html_url":"https://github.com/entangled/mkdocs-plugin","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/entangled/mkdocs-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/entangled","download_url":"https://codeload.github.com/entangled/mkdocs-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266886030,"owners_count":24001046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["literate-programming","markdown","mkdocs-plugin"],"created_at":"2025-07-24T18:17:48.512Z","updated_at":"2025-10-25T22:08:47.816Z","avatar_url":"https://github.com/entangled.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Welcome to MkDocs Entangled Plugin\nUsing this plugin, you can make your Entangled documents look better.\n\n## Examples\nDetailed examples are found in the [entangled/mkdocs-examples repository](https://entangled.github.io/mkdocs-examples).\n\n## Install\n\nInstall this with `pip install mkdocs-entangled-plugin`. To use the entangled plugin, add the following lines to your `mkdocs.yml`:\n\n```yaml\nplugins:\n  - entangled\n\nmarkdown_extensions:\n  - pymdownx.superfences\n  - pymdownx.tabbed:\n      alternate_style: true \n```\n\nFor more information, see [the documentation](https://entangled.github.io/mkdocs-plugin).\n\n## Components\nThis plugin bundles functionality for literate programming with Entangled.\n\n- Annotate code blocks with titles.\n- Build artifacts using Make.\n\n### Annotate code blocks\nThe default markdown syntax that Entangled supports has fenced code blocks as follows\n\n~~~markdown\n``` {.python file=examples/hello_world.py}\nif __name__ == \"__main__\":\n    \u003c\u003chello-world\u003e\u003e\n```\n~~~\n\nWhich renders like this:\n\n``` {.python file=examples/hello_world.py}\nif __name__ == \"__main__\":\n    \u003c\u003chello-world\u003e\u003e\n```\n\nOr named code blocks\n\n~~~markdown\n``` {.python #hello-world}\nprint(\"Hello, World!\")\n```\n~~~\n\nthat render like this:\n\n``` {.python #hello-world}\nprint(\"Hello, Universe!\")\n```\n\n### Build Artifacts\n\nBuild artifacts by specifying a Makefile.\n\n~~~markdown\n=== \"Figure 1\"\n\n    ![](fig/plot.svg)\n\n=== \"Source\"\n\n    ``` {.gnuplot file=examples/plot.gp}\n    # enter your plotting commands here\n    ```\n\n    ``` {.make .build-artifact}\n    .RECIPEPREFIX = \u003e\n  \n    docs/fig/plot.svg: examples/plot.gp\n    \u003e mkdir -p $(@D)\n    \u003e gnuplot $^ \u003e $@\n    ```\n~~~\n\n=== \"Figure 1\"\n\n    ![](fig/plot.svg)\n\n=== \"Source\"\n\n    ``` {.gnuplot file=examples/plot.gp}\n    set term svg background rgb 'white' size 700, 500\n    sinc(r) = sin(pi*r) / (pi*r)\n    set isosamples 50, 50\n    set hidden3d\n    set xrange [-4:4]\n    set yrange [-4:4]\n    set xyplane 0\n    set title \"Sinc function\"\n    splot sinc(sqrt(x**2 + y**2)) t'' lc rgb '#5533cc'\n    ```\n\n    ``` {.make .build-artifact}\n    .RECIPEPREFIX = \u003e\n  \n    docs/fig/plot.svg: examples/plot.gp\n    \u003e mkdir -p $(@D)\n    \u003e gnuplot $^ \u003e $@\n    ```\n\n## License\nLicensed under the Apache-2 license agreement: see LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fentangled%2Fmkdocs-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fentangled%2Fmkdocs-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fentangled%2Fmkdocs-plugin/lists"}