Add overlay on wikipedia links in MkDocs
Project description
MkDocs Wikipedia Plugin
This plugin allows you to fetch and display Wikipedia summaries in your MkDocs pages. It is compatible with MkDocs Material and MkDocs Books.
Installation
pip install mkdocs-wikipedia
Activate the plugin in your mkdocs.yml:
plugins:
- wikipedia:
language: "fr"
timeout: 5
Install the plugin using pip:
pip install mkdocs-wikipedia
Activate the plugin in your mkdocs.yml:
plugins:
- wikipedia:
language: "fr"
timeout: 5
filename: "links.yml" # Optional, default is "links.yml"
Usage
In you pages, when you add a wikipedia tag, it will be replaced by the summary of the corresponding Wikipedia page.
[MkDocs](https://en.wikipedia.org/wiki/MkDocs)
Project details
Release history Release notifications | RSS feed
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_wikipedia-0.1.0.tar.gz.
File metadata
- Download URL: mkdocs_wikipedia-0.1.0.tar.gz
- Upload date:
- Size: 9.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d583df4aababe439b75066b7c1e4080d5b5e063470f6a49b7a839b30abd98498
|
|
| MD5 |
18d16d5246ab427dfd7b401294fe87c5
|
|
| BLAKE2b-256 |
2e866da90ca8bea3e2d24fe1fe2150f9e6f6750fc46747016f12ff99aa43ad8c
|
Provenance
The following attestation bundles were made for mkdocs_wikipedia-0.1.0.tar.gz:
Publisher:
ci.yml on yves-chevallier/mkdocs-wikipedia
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_wikipedia-0.1.0.tar.gz -
Subject digest:
d583df4aababe439b75066b7c1e4080d5b5e063470f6a49b7a839b30abd98498 - Sigstore transparency entry: 601260872
- Sigstore integration time:
-
Permalink:
yves-chevallier/mkdocs-wikipedia@0e112742c06218a4d42e3bf52fed9d13d704aefe -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/yves-chevallier
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@0e112742c06218a4d42e3bf52fed9d13d704aefe -
Trigger Event:
push
-
Statement type:
File details
Details for the file mkdocs_wikipedia-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mkdocs_wikipedia-0.1.0-py3-none-any.whl
- Upload date:
- Size: 11.1 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 |
d0b5f0a35977d2cff4262c79cc75f96a1fd2b5ef034ec3981dc4d93d29c2c08a
|
|
| MD5 |
934c19640a467dfa4bac32d0a4a14947
|
|
| BLAKE2b-256 |
cf0462266ee6558710bb2818f2154009875f44a6da4cdcb11f412801f0d66e97
|
Provenance
The following attestation bundles were made for mkdocs_wikipedia-0.1.0-py3-none-any.whl:
Publisher:
ci.yml on yves-chevallier/mkdocs-wikipedia
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mkdocs_wikipedia-0.1.0-py3-none-any.whl -
Subject digest:
d0b5f0a35977d2cff4262c79cc75f96a1fd2b5ef034ec3981dc4d93d29c2c08a - Sigstore transparency entry: 601260873
- Sigstore integration time:
-
Permalink:
yves-chevallier/mkdocs-wikipedia@0e112742c06218a4d42e3bf52fed9d13d704aefe -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/yves-chevallier
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@0e112742c06218a4d42e3bf52fed9d13d704aefe -
Trigger Event:
push
-
Statement type: