Skip to main content

A mkdocs plugin inspired by dataview plugin in Obsidian

Project description

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

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

mkdocs_dataview-0.0.1.tar.gz (8.5 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.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_dataview-0.0.1.tar.gz.

File metadata

  • Download URL: mkdocs_dataview-0.0.1.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mkdocs_dataview-0.0.1.tar.gz
Algorithm Hash digest
SHA256 cbdd2a4e136cc260c12f03469c5cf6143b331196cd598d184a79195e5438f9c3
MD5 299dd9dfb106ed45e0793b491b6ed298
BLAKE2b-256 2ea2c32ee51ed3f723cefc30dc535eb5ac8a95f328141b28855c7180c1bdd44f

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_dataview-0.0.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_dataview-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe0fc22eb96f8e2fc6be1fd37aa433695cc09181e7d907a1550914061922637d
MD5 0b4d0b724dd5340b3815ae76936f1b51
BLAKE2b-256 afa51b7251d30e73a6b038bcc88a4f7363f37ae322754a335f29c50ed86b08f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_dataview-0.0.1-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.

Supported by

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