Auto-fetch Metadata¶
The following example simply specifies the URL for the target website. The name, description, favicon, and image are auto-generated.
Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, in 60+ languages, for all devices
Custom Values¶
This example uses the same link as the one above, however, each value is manually defined:
MkDocs is a fast, simple and downright gorgeous static site generator thats 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.
```embed
url: https://squidfunk.github.io/mkdocs-material/
image: https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQjFUDe-vdiprKpCsiLoRmfCdUq0WS5tqUR9fyEzJjQ0g&s
name: Github: Download Mkdocs
desc: 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.
favicon: https://github.com/Aetherinox/mkdocs-link-embeds/assets/118329232/6433449b-2988-4da3-9d43-ff4c992a9fcf
favicon_size: 25
```
Minimal¶
The following example displays a website, however, removes the image and favicon completely.
MkDocs is a fast, simple and downright gorgeous static site generator thats 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.
```embed
url: https://squidfunk.github.io/mkdocs-material/
name: Github: Download Mkdocs
desc: 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.
image: false
favicon: false
```
Accent Color¶
The following presents an embedded link with a custom accent color border
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 value...
Unresolvable URL¶
The following is an example of a bad URL being rendered.
No description found