A mkdocs plugin inspired by dataview plugin in Obsidian
Project description
mkdocs-dataview-plugin
Plugin for mkdocs that allows to build markdown tables on metadata
Overview
mkdocs-dataview-plugin is a plugin that makes it easier to build markdown tables on data based on other files metadata during the build step. Typical usecase are: registries, summary pages, section for replated pages based on similar tag.
---
title: How to do a heapsort
group_tag: group-sorting-algorithms
tags:
- group-sorting-algorithms
---
Related algorithms:
```dataview
file.link
WHERE this.file.metadata.group_tag in tags and this.file.title != title
```
Installation
There are two usage options:
- as mkdocs plugin
- as a separate tool for gerenating .md files from templates
Mkdocs plugin
Just add dataview to plugin list in mkdocs.yml, no other configuration is required.
plugins:
- dataview
As a separate tool
In case you can't use plugin option, write markdowns files with dataview
Development
Prepare environment
python -m venv .venv
source .venv/bin/activate
pip install .
```
Do some changes in the code and run tests:
```bash
pytest
```
You should also check that examples folder is working just by running:
```bash
mkdocs serve
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mkdocs_dataview-0.0.4.tar.gz.
File metadata
- Download URL: mkdocs_dataview-0.0.4.tar.gz
- Upload date:
- Size: 27.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
79853fdee7782f320a00cbb94b2774f80a99565b36bbf1cff8d70639925d04b5
|
|
| MD5 |
6f42725cae44a12c0958dfc521795384
|
|
| BLAKE2b-256 |
309fecbb1bc1005e9f7bdfa3682a3b3c084d104e3433fd2c75805eabc5d681ce
|
Provenance
The following attestation bundles were made for mkdocs_dataview-0.0.4.tar.gz:
Publisher:
publish.yml on kepkin/mkdocs-dataview-plugin
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_dataview-0.0.4.tar.gz -
Subject digest:
79853fdee7782f320a00cbb94b2774f80a99565b36bbf1cff8d70639925d04b5 - Sigstore transparency entry: 983939546
- Sigstore integration time:
-
Permalink:
kepkin/mkdocs-dataview-plugin@022332f77f6579071252d140ce73d0c62ef27302 -
Branch / Tag:
refs/tags/0.0.4 - Owner: https://github.com/kepkin
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@022332f77f6579071252d140ce73d0c62ef27302 -
Trigger Event:
release
-
Statement type:
File details
Details for the file mkdocs_dataview-0.0.4-py3-none-any.whl.
File metadata
- Download URL: mkdocs_dataview-0.0.4-py3-none-any.whl
- Upload date:
- Size: 15.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ec26ef9b329139f2c6302f046a7cf6929e0baf7c83aaa0ac1d56c07274e6880
|
|
| MD5 |
1fbcb4017e6c93b6825bb9a1e8db1c62
|
|
| BLAKE2b-256 |
54fdbaa4dd2fc24a54d90173df66d2e949ca38964b32885a211e09ac8be1113a
|
Provenance
The following attestation bundles were made for mkdocs_dataview-0.0.4-py3-none-any.whl:
Publisher:
publish.yml on kepkin/mkdocs-dataview-plugin
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_dataview-0.0.4-py3-none-any.whl -
Subject digest:
9ec26ef9b329139f2c6302f046a7cf6929e0baf7c83aaa0ac1d56c07274e6880 - Sigstore transparency entry: 983939574
- Sigstore integration time:
-
Permalink:
kepkin/mkdocs-dataview-plugin@022332f77f6579071252d140ce73d0c62ef27302 -
Branch / Tag:
refs/tags/0.0.4 - Owner: https://github.com/kepkin
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@022332f77f6579071252d140ce73d0c62ef27302 -
Trigger Event:
release
-
Statement type: