Skip to content

yves-chevallier/mkdocs-wikipedia

Repository files navigation

MkDocs Wikipedia Plugin

CI Coverage PyPI Repo Size Python Versions License

MkDocs MkDocs Material Wikipedia Python

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)

About

Hover to wikipedia links in your docs and see summary and preview image.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors