Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

mkdocs-backlinks-section-plugin

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mkdocs-backlinks-section-plugin

Adds a backlinks section that lists every page linking to the current page.

  • 0.0.3
  • PyPI
  • Socket score

Maintainers
1

PyPI version License Python versions

Adds a backlinks section that lists every page linking to the current page.

Installation

You can install it with pip:

pip install mkdocs-backlinks-section-plugin

Usage

Add the plugin to your mkdocs.yml:

plugins:
- search
- backlinks_section

Configuration

Text

You can customize the text inserted by the plugin with the configuration values below:

OptionTypeDefault value
titlestringBacklinks
descriptionstringThe following pages link to this page:
description_no_linksstringNo other pages link to this page.

So for example if you would want the text to be in German, you could do this in your mkdocs.yml:

plugins:
- search
- backlinks_section:
    title: Rückverweise
    description: "Die folgenden Seiten referenzieren die aktuelle Seite:"
    description_no_links: Es gibt keine Verweise auf diese Seite.

Ignore pages

You can ignore source and destination pages for the backlink section. The values are interpreted as glob-like patterns, wich are matched against the paths of the Markdown source files.

OptionTypeDefault value
ignore_links_fromlist of strings[]
ignore_links_tolist of strings[]

For example you may have a page listing all tags (and thus linking to almost all pages) and want to prevent every page having a backlink to it:

plugins:
- search
- backlinks_section:
    ignore_links_from:
    - path/with/globs/**/to/tags.md

If you do not want a backlinks section on some pages, you can disable it with the ignore_links_to option:

plugins:
- search
- backlinks_section:
    ignore_links_to:
    - path/with/globs/**/to/files-without-backlink-section-*.md
    - index.md

Notable changes

Version 0.0.3

  • Fixed crash with Python <= 3.12

Version 0.0.2

  • Added ignore_links_from and ignore_links_to configuration options

Version 0.0.1

  • Initial version

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc