mkdocs / catalog

:trophy: :books: A list of awesome MkDocs projects and plugins.
Creative Commons Attribution Share Alike 4.0 International
1k stars 58 forks source link

Add project: mkdocs-entangled #87

Closed jhidding closed 1 year ago

jhidding commented 1 year ago

Project details:

Additional context:

Entangled is a solution for Literate Programming, a technique in which the programmer writes a human narrative first, then implementing the program in code blocks.

Literate programming was introduced by Donald Knuth in 1984 and has since then found several surges in popularity. One thing holding back the popularity of literate programming is the lack of maintainability under increasing program complexity. Entangled solves this issue by offering a two-way synchronisation mechanism. You can edit and debug your code as normal in your favourite IDE or text editor. Entangled will make sure that your Markdown files stay up-to-date with your code and vice-versa. Because Entangled works with Markdown, you can use it with most static document generators.

The mkdocs-entangled plugin integrates Entangled into MkDocs' event loop, and includes a module for building artifacts using snippets of makefiles.

pawamoy commented 1 year ago

Thanks for the suggestion, PRs welcome!