{"id":14064698,"url":"https://github.com/Aetherinox/mkdocs-link-embeds","last_synced_at":"2025-07-29T18:33:57.474Z","repository":{"id":228399873,"uuid":"773820757","full_name":"Aetherinox/mkdocs-link-embeds","owner":"Aetherinox","description":"Mkdocs plugin which displays links in a more elegant way. Links will automatically be populated with an image, description, fav icon, and title for the target website; or you can override the values to give your own.","archived":false,"fork":false,"pushed_at":"2024-05-30T01:04:40.000Z","size":2484,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-30T17:59:05.231Z","etag":null,"topics":["documentation","mkdocs","mkdocs-material","mkdocs-material-theme","mkdocs-plugin","mkdocs-plugins","python"],"latest_commit_sha":null,"homepage":"https://aetherinox.github.io/mkdocs-link-embeds/","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/Aetherinox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":"docs/.github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"squidfunk"}},"created_at":"2024-03-18T13:09:53.000Z","updated_at":"2024-06-01T02:26:51.591Z","dependencies_parsed_at":"2024-04-17T13:43:08.275Z","dependency_job_id":"5953f828-ed5a-471e-be6e-3a27b48518f9","html_url":"https://github.com/Aetherinox/mkdocs-link-embeds","commit_stats":null,"previous_names":["aetherinox/mkdocs-link-embeds","aetherinaux/mkdocs-link-embeds"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aetherinox%2Fmkdocs-link-embeds","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aetherinox%2Fmkdocs-link-embeds/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aetherinox%2Fmkdocs-link-embeds/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Aetherinox%2Fmkdocs-link-embeds/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Aetherinox","download_url":"https://codeload.github.com/Aetherinox/mkdocs-link-embeds/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228040827,"owners_count":17860211,"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":["documentation","mkdocs","mkdocs-material","mkdocs-material-theme","mkdocs-plugin","mkdocs-plugins","python"],"created_at":"2024-08-13T07:04:01.569Z","updated_at":"2024-12-04T03:31:23.947Z","avatar_url":"https://github.com/Aetherinox.png","language":"Python","funding_links":["https://github.com/sponsors/squidfunk"],"categories":["Python"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch6\u003eMkdocs Plugin\u003c/h6\u003e\n\u003ch1\u003e♾️ Link Embeds ♾️\u003c/h1\u003e\n\n\u003cbr /\u003e\n\n\u003cp\u003eDisplay embedded links in a more elegant and modern way with the use of markdown codeblocks. Supports automatically fetching website data, or allows for you to override various values.\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\u003cimg src=\"https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/a30aff26-8cba-4a90-ab60-75105c5189d6\" width=\"630\"\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003c!-- prettier-ignore-start --\u003e\n[![Version][github-version-img]][github-version-uri] [![Version][pypi-version-img]][pypi-version-uri]  [![Build Status][github-build-pypi-img]][github-build-pypi-uri] [![Downloads][github-downloads-img]][github-downloads-uri] [![Size][github-size-img]][github-size-img] [![Last Commit][github-commit-img]][github-commit-img]\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n---\n\n\u003cbr /\u003e\n\n- [About](#about)\n- [Documentation](#documentation)\n- [Install](#install)\n  - [Usage](#usage)\n\n\u003cbr /\u003e\n\n---\n\n\u003cbr /\u003e\n\n# About\nThis plugin requires [mkdocs](https://www.mkdocs.org/) to function.\n\nThis plugin allows you to display embedded links in a more elegant and modern way with the use of markdown codeblocks. You may either specify a URL and let the plugin auto-fill in details such as the site description and title, or you can override the auto-generated values and add your own.\n\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg style=\"width: 85%;text-align: center;border: 1px solid #353535;\" src=\"https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/afc068d8-fd8e-448e-ab1c-b026cd5076d2\"\u003e\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg style=\"width: 85%;text-align: center;border: 1px solid #353535;\" src=\"https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/a30aff26-8cba-4a90-ab60-75105c5189d6\"\u003e\u003c/p\u003e\n\n\u003cbr /\u003e\n\n---\n\n\u003cbr /\u003e\n\n# Documentation\nIf you wish to view the complete documentation for this plugin, including installation and usage; visit https://aetherinox.github.io/mkdocs-link-embeds/\n\n\u003cbr /\u003e\n\n---\n\n\u003cbr /\u003e\n\n# Install\n\nInstall the package for this plugin by running the command:\n\n```text\npip install mkdocs-link-embeds-plugin\n```\n\n\u003cbr /\u003e\n\nOnce you [install](#install) the package above, open your `mkdocs.yml` and add a few new lines:\n\n\u003cbr /\u003e\n\n```yaml\nplugins:\n  - link-embeds:\n      enabled: true\n      name_default: \"Untitled Link\"\n      desc_default: \"No description found\"\n      image_default: \"https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/c0298d98-0910-4235-a88f-0c3e2f704ba7\"\n      image_disabled: false\n      favicon_default: \"https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/b37da9c6-6f17-4c3f-9c94-c346a6f31bfa\"\n      favicon_disabled: false\n      favicon_size: 25\n      target: \"blank\"\n      accent: \"FFFFFF1A\"\n      verbose: false\n\nextra_css:\n  - path/to/link-embeds.css\n```\n\n\u003cbr /\u003e\n\nEnsure you download the contents of `mkdocs_link_embeds_plugin/resources/link-embeds.css` and place the file in your mkdocs directory. It must be placed in the path you specified under `extra_css` in the mkdocs.yml config above.\n\n\u003cbr /\u003e\n\n---\n\n\u003cbr /\u003e\n\n## Usage\nOnce you have installed this plugin, you may now create a new page in your mkdocs project and insert a new codeblock with the following syntax:\n\n\u003cbr /\u003e\n\n````markdown\n```embed\nurl:            https://github.com/mkdocs/mkdocs/releases\nname:           Github: Download Mkdocs\ndesc:           MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.\nimage:          https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/98179e23-ce03-4101-a858-56db0cd0e8f0\nfavicon:        https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/13a151b1-d7f9-4e27-909b-a26986ab0954\nfavicon_size:   25\ntarget:         new\naccent:         4C59BFE0\n```\n````\n\n\u003cbr /\u003e\n\nThis plugin accepts numerous properties:\n- `url`: The URL to the link.\n- `name`: Name / Title to show at the top of each embed.\n- `desc`: A description of what the site is for.\n- `image`: Image to display on the left side of each embedded website.\n- `favicon`: Favicon to display at the bottom, next to the link.\n- `favicon_size`: Favicon size.\n- `target`: Determines whether link opens in new window or same window.\n- `accent`: Specify accent color for embedded link surrounding border\n\n\u003cbr /\u003e\n\nThe only **required** value is `url`.\n\n\u003cbr /\u003e\n\nIf you provide only the `url`, and leave the others out; the plugin will attempt to check if your URL is valid, and then auto-fetch the metadata for that website. It will be used to populate the fields you did not provide.\n\n\u003cbr /\u003e\n\nIf you do provide values such as `desc`, `name`, or `image`; those user inputs will take priority over the automatically fetched values.\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n\u003c!-- prettier-ignore-start --\u003e\n\n\u003c!-- BADGE \u003e GENERAL --\u003e\n  [general-npmjs-uri]: https://npmjs.com\n  [general-nodejs-uri]: https://nodejs.org\n  [general-npmtrends-uri]: http://npmtrends.com/mkdocs-link-embeds\n\n\u003c!-- BADGE \u003e VERSION \u003e GITHUB --\u003e\n  [github-version-img]: https://img.shields.io/github/v/tag/Aetherinox/mkdocs-link-embeds?logo=GitHub\u0026label=Version\u0026color=ba5225\n  [github-version-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/releases\n\n\u003c!-- BADGE \u003e VERSION \u003e NPMJS --\u003e\n  [npm-version-img]: https://img.shields.io/npm/v/mkdocs-link-embeds?logo=npm\u0026label=Version\u0026color=ba5225\n  [npm-version-uri]: https://npmjs.com/package/mkdocs-link-embeds\n\n\u003c!-- BADGE \u003e VERSION \u003e PYPI --\u003e\n  [pypi-version-img]: https://img.shields.io/pypi/v/mkdocs-link-embeds-plugin\n  [pypi-version-uri]: https://pypi.org/project/mkdocs-link-embeds-plugin/\n\n\u003c!-- BADGE \u003e LICENSE \u003e MIT --\u003e\n  [license-mit-img]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons\u0026logoColor=FFFFFF\u0026label=License\u0026color=9d29a0\n  [license-mit-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/blob/main/LICENSE\n\n\u003c!-- BADGE \u003e GITHUB \u003e DOWNLOAD COUNT --\u003e\n  [github-downloads-img]: https://img.shields.io/github/downloads/Aetherinox/mkdocs-link-embeds/total?logo=github\u0026logoColor=FFFFFF\u0026label=Downloads\u0026color=376892\n  [github-downloads-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/releases\n\n\u003c!-- BADGE \u003e NPMJS \u003e DOWNLOAD COUNT --\u003e\n  [npmjs-downloads-img]: https://img.shields.io/npm/dw/%40aetherinox%2Fmkdocs-link-embeds?logo=npm\u0026\u0026label=Downloads\u0026color=376892\n  [npmjs-downloads-uri]: https://npmjs.com/package/mkdocs-link-embeds\n\n\u003c!-- BADGE \u003e GITHUB \u003e DOWNLOAD SIZE --\u003e\n  [github-size-img]: https://img.shields.io/github/repo-size/Aetherinox/mkdocs-link-embeds?logo=github\u0026label=Size\u0026color=59702a\n  [github-size-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/releases\n\n\u003c!-- BADGE \u003e NPMJS \u003e DOWNLOAD SIZE --\u003e\n  [npmjs-size-img]: https://img.shields.io/npm/unpacked-size/mkdocs-link-embeds/latest?logo=npm\u0026label=Size\u0026color=59702a\n  [npmjs-size-uri]: https://npmjs.com/package/mkdocs-link-embeds\n\n\u003c!-- BADGE \u003e CODECOV \u003e COVERAGE --\u003e\n  [codecov-coverage-img]: https://img.shields.io/codecov/c/github/Aetherinox/mkdocs-link-embeds?token=MPAVASGIOG\u0026logo=codecov\u0026logoColor=FFFFFF\u0026label=Coverage\u0026color=354b9e\n  [codecov-coverage-uri]: https://codecov.io/github/Aetherinox/mkdocs-link-embeds\n\n\u003c!-- BADGE \u003e ALL CONTRIBUTORS --\u003e\n  [contribs-all-img]: https://img.shields.io/github/all-contributors/Aetherinox/mkdocs-link-embeds?logo=contributorcovenant\u0026color=de1f6f\u0026label=contributors\n  [contribs-all-uri]: https://github.com/all-contributors/all-contributors\n\n\u003c!-- BADGE \u003e GITHUB \u003e BUILD \u003e NPM --\u003e\n  [github-build-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/mkdocs-link-embeds/npm-release.yml?logo=github\u0026logoColor=FFFFFF\u0026label=Build\u0026color=%23278b30\n  [github-build-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/actions/workflows/npm-release.yml\n\n\u003c!-- BADGE \u003e GITHUB \u003e BUILD \u003e Pypi --\u003e\n  [github-build-pypi-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/mkdocs-link-embeds/release-pypi.yml?logo=github\u0026logoColor=FFFFFF\u0026label=Build\u0026color=%23278b30\n  [github-build-pypi-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/actions/workflows/release-pypi.yml\n\n\u003c!-- BADGE \u003e GITHUB \u003e TESTS --\u003e\n  [github-tests-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/mkdocs-link-embeds/npm-tests.yml?logo=github\u0026label=Tests\u0026color=2c6488\n  [github-tests-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/actions/workflows/tests.yml\n\n\u003c!-- BADGE \u003e GITHUB \u003e COMMIT --\u003e\n  [github-commit-img]: https://img.shields.io/github/last-commit/Aetherinox/mkdocs-link-embeds?logo=conventionalcommits\u0026logoColor=FFFFFF\u0026label=Last%20Commit\u0026color=313131\n  [github-commit-uri]: https://github.com/Aetherinox/mkdocs-link-embeds/commits/main/\n\u003c!-- prettier-ignore-end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAetherinox%2Fmkdocs-link-embeds","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAetherinox%2Fmkdocs-link-embeds","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAetherinox%2Fmkdocs-link-embeds/lists"}