{"id":28308128,"url":"https://github.com/entangled/mkdocs-examples","last_synced_at":"2026-01-26T21:13:10.209Z","repository":{"id":170564168,"uuid":"646613636","full_name":"entangled/mkdocs-examples","owner":"entangled","description":"Entangled demo using MkDocs","archived":false,"fork":false,"pushed_at":"2023-05-29T08:00:57.000Z","size":2643,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-21T02:37:09.784Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"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-05-28T23:59:30.000Z","updated_at":"2023-05-28T23:59:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"a34dba8a-87b2-446b-991b-595f09106f11","html_url":"https://github.com/entangled/mkdocs-examples","commit_stats":null,"previous_names":["entangled/mkdocs-examples"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/entangled/mkdocs-examples","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/entangled","download_url":"https://codeload.github.com/entangled/mkdocs-examples/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/entangled%2Fmkdocs-examples/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28788323,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:02:48.137Z","status":"ssl_error","status_checked_at":"2026-01-26T21:01:13.039Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2025-05-24T07:09:03.809Z","updated_at":"2026-01-26T21:13:10.201Z","avatar_url":"https://github.com/entangled.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Entangled Examples for MkDocs\n\n[![Entangled badge](https://img.shields.io/badge/entangled-Use%20the%20source!-%2300aeff)](https://entangled.github.io/)\n[![Deploy Pages](https://github.com/entangled/mkdocs-examples/actions/workflows/deploy-pages.yaml/badge.svg)](https://github.com/entangled/mkdocs-examples/actions/workflows/deploy-pages.yaml)\n\nHere you find several examples of using Entangled with MkDocs.\n\n## Literate Programming\n\nThis project is written using literate programming with [Entangled](https://entangled.github.io/). This means that some or all of its source code is contained in Markdown code blocks. These code blocks are kept synchronized with a compilable and debuggable version of the program. When you edit either the Markdown or the generated source files, make sure you have the Entangled daemon running:\n\n```shell\nentangled watch\n```\n\nTe generate a rendered version of the Markdown, you may run\n\n```shell\nmkdocs build\n```\n\nor if you want to do both:\n\n```shell\nmkdocs serve\n```\n\nEntangled will run inside the MkDocs event loop.\n\n\u003cdetails\u003e\u003csummary\u003eHow to write code using Entangled\u003c/summary\u003e\n\n## Writing code\n\nFor didactic reasons we don’t always give the listing of an entire source file in one go. In stead, we use a system of references known as noweb (Ramsey 1994). You write code inside Markdown code blocks with the following syntax:\n\n~~~markdown\n``` {.cpp title=\"src/main.cpp\"}\n#include \u003ccstdlib\u003e\n#include \u003ciostream\u003e\n\n\u003c\u003cmain-function\u003e\u003e\n```\n~~~\n\nThis creates a file `src/main.cpp` containing a not-yet-specified `main` function. This main function will print a friendly message on the screen.\n\n~~~markdown\n``` {.cpp title=\"#hello-world\"}\nstd::cout \u003c\u003c \"Hello, World!\" \u003c\u003c std::endl;\n```\n~~~\n\nTo complete the program we need to create the `main` function.\n\n~~~markdown\n``` {.cpp title=\"#main-function\"}\nint main(int argc, char **argv) {\n    \u003c\u003chello-world\u003e\u003e\n}\n```\n~~~\n\nCode blocks can be appended on with more code by repeating the same name for the code block.\n\n~~~markdown\n``` {.cpp title=\"#hello-world\"}\nreturn EXIT_SUCCESS;\n```\n~~~\n\u003c/details\u003e\n\n## MkDocs\n\nThe documentation is generated using [MkDocs Material](https://squidfunk.github.io/mkdocs-material/). See those pages for information on supported syntax and available plugins.\n\nYou may install the dependencies using `poetry` and activate the virtual environment before building:\n\n```\npoetry install\npoetry shell\nmkdocs build\n```\n\nIf you don't (want to) use `poetry`:\n\n```\npython -m venv venv\n./venv/bin/activate\npip install .\nmkdocs build\n```\n\n## License\n\nThis template is licensed under the [Apache License v2.0](https://www.apache.org/licenses/LICENSE-2.0). See `LICENSE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fentangled%2Fmkdocs-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fentangled%2Fmkdocs-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fentangled%2Fmkdocs-examples/lists"}