Registry / web-framework / mkdocs-open-in-new-tab

mkdocs-open-in-new-tab

library1.0.8pypypiunverified

mkdocs-open-in-new-tab is an MkDocs plugin designed to automatically open outgoing links and PDF files in a new browser tab. As of version 1.0.8, it provides stable functionality for enhancing user navigation in MkDocs-generated documentation sites. Releases are infrequent but stable, addressing key compatibility and feature needs.

web-framework

pip install mkdocs-open-in-new-tab

github ↗package ↗

INSTALL

IMPORT

SIG · MKDOCS-OPEN-IN-NEW

mkdocs-open-in-new-tab

web-frameworkpythonv1.0.8

Install

3.0s avg

Import

—

Disk

32MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.8 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.000s · 33MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 3.0s · import 0.000s · 34MB

32MB installed

● package 32MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

open-in-new-tab

✓ plugins: - open-in-new-tab

✗ plugins: - mkdocs_open_in_new_tab

MkDocs plugins are enabled in mkdocs.yml using their registered plugin name ('open-in-new-tab'), not the PyPI package name ('mkdocs-open-in-new-tab') or a Python import.

To enable the plugin, add 'open-in-new-tab' to the 'plugins' section of your `mkdocs.yml` configuration file. You can optionally configure 'external_only' and 'pdf_only' to control its behavior.

site_name: My Docs plugins: - open-in-new-tab: external_only: true # Only open external links in new tabs pdf_only: false # Do not open PDF links in new tabs

Debug

Known issues

gotchaEnsure MkDocs is installed and accessible in your environment. As a plugin, it relies on MkDocs to run and generate documentation.

fix

Install MkDocs: `pip install mkdocs`

affects: All versions

gotchaVersions prior to 1.0.3 had a known issue where they could interfere with MkDocs' instant loading feature, causing navigation problems.

fix

Upgrade to version 1.0.3 or newer: `pip install --upgrade mkdocs-open-in-new-tab`

affects: <1.0.3

gotchaIncorrectly configuring `external_only` or `pdf_only` can lead to unexpected link behavior. For instance, setting `external_only: false` will make *all* links (internal and external) open in new tabs, which might not be desired.

fix

Review the plugin's configuration options in `mkdocs.yml`. Set `external_only: true` to target only external links, and `pdf_only: true` (or `false`) based on your specific needs for PDF links.

affects: All versions

Upgrade

Version history

1.0.8latest on PyPI · released Nov 18, 2024

Audit

Dependencies

mkdocsrequiredThis package is an MkDocs plugin and requires MkDocs to function.

Agent activity

3 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/JakubAndrysek/mkdocs-open-in-new-tab ↗

packagehttps://pypi.org/project/mkdocs-open-in-new-tab/ ↗