{"id":13795075,"url":"https://github.com/zachhannum/mkdocs-tooltipster-links-plugin","last_synced_at":"2025-12-11T20:43:32.707Z","repository":{"id":44914965,"uuid":"233260347","full_name":"zachhannum/mkdocs-tooltipster-links-plugin","owner":"zachhannum","description":"An MkDocs plugin that adds tooltips to preview the content of page links using tooltipster","archived":false,"fork":false,"pushed_at":"2022-09-20T10:38:00.000Z","size":1282,"stargazers_count":7,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-19T02:10:21.457Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zachhannum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-11T16:20:03.000Z","updated_at":"2024-05-05T15:23:40.000Z","dependencies_parsed_at":"2022-09-05T13:11:59.877Z","dependency_job_id":null,"html_url":"https://github.com/zachhannum/mkdocs-tooltipster-links-plugin","commit_stats":null,"previous_names":["midnightprioriem/mkdocs-tooltipster-links-plugin"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-tooltipster-links-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-tooltipster-links-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-tooltipster-links-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zachhannum%2Fmkdocs-tooltipster-links-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zachhannum","download_url":"https://codeload.github.com/zachhannum/mkdocs-tooltipster-links-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208561,"owners_count":21065202,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T23:00:51.899Z","updated_at":"2025-12-11T20:43:27.679Z","avatar_url":"https://github.com/zachhannum.png","language":"Python","funding_links":[],"categories":["Site Generators"],"sub_categories":["MkDocs Extensions"],"readme":"# mkdocs-tooltipster-links-plugin\n\nAn MkDocs plugin that adds tooltips to preview the content of page links using tooltipster\n\n![demo](demo/mkdocs_tooltipster_links_demo.gif)\n\n## Setup\n\n### Install the Plugin\n\nInstall the plugin using pip:\n\n`pip install mkdocs-tooltipster-links-plugin`\n\nActivate the plugin in `mkdocs.yml`:\n```yaml\nplugins:\n  - search\n  - tooltipster-links\n```\n\n\u003e **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.\n\nMore information about plugins in the [MkDocs documentation][mkdocs-plugins].\n\n### Install Tooltipster\n\nPlease reference [Tooltipster's getting started guide](http://iamceege.github.io/tooltipster/#getting-started) for additional installation instructions.\n\nDownload Tooltipster and add the css and javascript to `mkdocs.yml`:\n\n```yml\nextra_css:\n  - css/tooltipster.bundle.min.css\n\nextra_javascript:\n  - js/tooltipster.bundle.js  \n```\n\nCreate custom directory and `main.html` file for overriding the `extra_head` template block\n\n```sh\nmkdir theme\ntouch theme/main.html\n```\n\nAdd the following to `main.html`:\n```html\n{% extends \"base.html\" %}\n\n{% block extrahead %}\n        \u003cscript src=\"https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js\"\u003e\u003c/script\u003e\n        \u003cscript\u003e\n                $(document).ready(function() {\n                    $('.link-tooltip').tooltipster();\n                });\n        \u003c/script\u003e\n{% endblock %}\n```\nAdd the custom directory to `mkdocs.yml`:\n```yml\ntheme:\n  name: mkdocs\n  custom_dir: theme\n```\n\nAdd additonal css to the site (either in a new css file or existing one):\n```css\n.tooltip_templates { display: none; }\n```\n\n## Usage\nOnce configured property, tooltips-links should create tooltips automagically!\n\n## See Also\n\nMore information about templates [here][mkdocs-template].\n\nMore information about blocks [here][mkdocs-block].\n\n[mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/\n[mkdocs-template]: https://www.mkdocs.org/user-guide/custom-themes/#template-variables\n[mkdocs-block]: https://www.mkdocs.org/user-guide/styling-your-docs/#overriding-template-blocks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzachhannum%2Fmkdocs-tooltipster-links-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzachhannum%2Fmkdocs-tooltipster-links-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzachhannum%2Fmkdocs-tooltipster-links-plugin/lists"}