Fork of midnightprioriem/mkdocs-tooltipster-links-plugin
mkdocs-tooltipster-links-plugin
An MkDocs plugin that adds tooltips to preview the content of page links using tooltipster
Setup
Install the Plugin
Install the plugin using pip:
pip install mkdocs-preview-links-plugin
Activate the plugin in mkdocs.yml:
plugins:
- search
- tooltipster-links
Note: If you have no
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation.
Install Tooltipster
Please reference Tooltipster's getting started guide for additional installation instructions.
Download Tooltipster and add the css and javascript to mkdocs.yml:
extra_css:
- css/tooltipster.bundle.min.css
extra_javascript:
- js/tooltipster.bundle.js
Create custom directory and main.html file for overriding the extra_head template block
mkdir theme
touch theme/main.html
Add the following to main.html:
{% extends "base.html" %}
{% block extrahead %}
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<script>
$(document).ready(function() {
$('.link-tooltip').tooltipster();
});
</script>
{% endblock %}
Add the custom directory to mkdocs.yml:
theme:
name: mkdocs
custom_dir: theme
Add additonal css to the site (either in a new css file or existing one):
.tooltip_templates { display: none; }
Usage
Once configured property, tooltips-links should create tooltips automagically!
See Also
More information about templates here.
More information about blocks here.
Metadata
Release files for mkdocs-preview-links-plugin 0.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-preview-links-plugin-0.2.2.tar.gz | 4.7 kB | Without provenance | Details for mkdocs-preview-links-plugin-0.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_preview_links_plugin-0.2.2-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_preview_links_plugin-0.2.2-py3-none-any.whl |
Total release size: 10.0 kB
Release files / mkdocs-preview-links-plugin-0.2.2.tar.gz
| Download URL | mkdocs-preview-links-plugin-0.2.2.tar.gz |
|---|---|
| Size | 4.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
66a613895517b9c470c45e1b07bbc40417085779be8daf4cb31a7d86b5815227
|
|
BLAKE2b-256 checksum How to use checksums |
8bdfeff8e75d8515046e72da78bf252c1ac52f4c23cf308b66471f484b93dbfc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.11
|
Release files / mkdocs_preview_links_plugin-0.2.2-py3-none-any.whl
| Download URL | mkdocs_preview_links_plugin-0.2.2-py3-none-any.whl |
|---|---|
| Size | 5.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ed07d6577d3f7a2971b0bae4d85057859ea34a5399dfc4502c19c87fe26fd72a
|
|
BLAKE2b-256 checksum How to use checksums |
84b918bd699635f1f3a1d41e3897806211a1828ae5fc0c48fb0a05fc09bab178
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.11
|
Security for mkdocs-preview-links-plugin 0.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.