Skip to content

Commit a7c96cd

Browse files
authored
docs: document config with zensical.toml (#165)
1 parent d991d10 commit a7c96cd

9 files changed

Lines changed: 920 additions & 448 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<h1 align="center">mkdocstrings-matlab</h1>
44

5-
<p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
5+
<p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>,</br>compatible with <a href="https://squidfunk.github.io/mkdocs-material">Material for MkDocs</a> and <a href="https://zensical.org/about/">Zensical</a>.</p>
66

77
<p align="center"><img width=300px src="logo.png"></p>
88

@@ -31,6 +31,8 @@ To get started, checkout the [📝 documentation](https://watermarkhu.github.io/
3131

3232
## Features
3333

34+
- Compatible with both [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material) and [Zensical](https://zensical.org/about/).
35+
3436
- 🤖 **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
3537
[Tree-sitter](https://tree-sitter.github.io/tree-sitter/).
3638

0 commit comments

Comments
 (0)