mkdocs-dataview-plugin

Python package

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
```

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Alexandr.Nevskiy from gravatar.com Alexandr.Nevskiy

Credits

Author: Alexander Nevskiy

License

MIT License

Requires

Python >=3.8

Provides Extra

docs

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_dataview-0.0.4.tar.gz (27.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_dataview-0.0.4-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

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

Hashes for mkdocs_dataview-0.0.4.tar.gz
Algorithm Hash digest
SHA256 79853fdee7782f320a00cbb94b2774f80a99565b36bbf1cff8d70639925d04b5
MD5 6f42725cae44a12c0958dfc521795384
BLAKE2b-256 309fecbb1bc1005e9f7bdfa3682a3b3c084d104e3433fd2c75805eabc5d681ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_dataview-0.0.4.tar.gz:

Publisher: publish.yml on kepkin/mkdocs-dataview-plugin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_dataview-0.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_dataview-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9ec26ef9b329139f2c6302f046a7cf6929e0baf7c83aaa0ac1d56c07274e6880
MD5 1fbcb4017e6c93b6825bb9a1e8db1c62
BLAKE2b-256 54fdbaa4dd2fc24a54d90173df66d2e949ca38964b32885a211e09ac8be1113a

See more details on using hashes here.

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

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page