https://github.com/axiros/docutools

Dev Centric Tools for Mkdocs Based Documentation
https://github.com/axiros/docutools

documentation literate-programming mkdocs mkdocs-material mkdocs-material-theme mkdocs-plugins

Last synced: 2 months ago
JSON representation

Dev Centric Tools for Mkdocs Based Documentation

• Host: GitHub
• URL: https://github.com/axiros/docutools
• Owner: axiros
• License: bsd-2-clause
• Created: 2021-10-04T21:36:07.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-09-04T16:57:48.000Z (over 1 year ago)
• Last Synced: 2024-04-16T02:11:34.051Z (8 months ago)
• Topics: documentation, literate-programming, mkdocs, mkdocs-material, mkdocs-material-theme, mkdocs-plugins
• Language: Python
• Homepage:
• Size: 29.8 MB
• Stars: 20
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - axiros/docutools - Dev Centric Tools for Mkdocs Based Documentation (documentation)

README

        
#  docutools

[![docs pages][docs pages_img]][docs pages] [![gh-ci][gh-ci_img]][gh-ci] [![pkg][pkg_img]][pkg] [![code_style][code_style_img]][code_style] 

[docs pages]: https://axiros.github.io/docutools

[docs pages_img]: https://axiros.github.io/docutools/img/badge_docs.svg

[gh-ci]: https://github.com/axiros/docutools/actions/workflows/ci.yml

[gh-ci_img]: https://github.com/axiros/docutools/actions/workflows/ci.yml/badge.svg

[pkg]: https://pypi.org/project/docutools/2022.04.11/

[pkg_img]: https://axiros.github.io/docutools/img/badge_pypi.svg

[code_style]: https://pypi.org/project/axblack/

[code_style_img]: https://axiros.github.io/docutools/img/badge_axblack.svg

## [MkDocs Documentation](https://axiros.github.io/docutools/) Tools For Developers

This repo is providing a set of plugins for [mkdocs material](https://squidfunk.github.io/mkdocs-material/) compatible documentation.

It is meant to be used as a development dependency for projects, intended to be used mainly by the

developers themselves, i.e. for the more technical, code centric parts of software project documentation.

Most notable feature: **[Literate Programming](https://axiros.github.io/docutools/features/lp/)**, i.e. dynamic code execution - tightly integrated within the mkdocs framework.

> Most plugins should work in [other](https://www.mkdocs.org/dev-guide/themes/) mkdocs themes as well. No guarantees though.

## [Feature](https://axiros.github.io/docutools/features/) Gallery

bash


bash


bash


call_flow_logging


call_flow_logging


chart


chartist


column


comments


convert


convert


cov_report


data_table


diag_diagram


drawio


find-pages


flowchart


git_changelog


kroki


kroki


lightbox


lprunner


make_badges


markmap


md-replace


md-replace


mermaid


page-tree


project_dependencies


python


screenshot


stats


xterm