A plugin to quote file from docs
Project description
Embed File
A way to embed a file present in your docs. Support both wikilinks & normal links. Intended to be used by obsidian user.
Activate the plugin
- Run
pip install mkdocs-embed-file-plugins
- Update your
mkdocs.yml
with :plugins: - search - embed_file
- Override your
main.html
with :{% extends "base.html" %} {% block extrahead %} <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5.15.4/css/fontawesome.min.css" integrity="sha384-jLKHWM3JRmfMU0A5x5AkjWkw/EYfGUAGagvnfryNV3F9VqM98XiIH7VBGVoxVSc7" crossorigin="anonymous"> {% endblock %}
Usage
Usage | wikilinks | markdown links |
---|---|---|
cite a entire file | ![[filename]] |
![](filename) |
Cite a heading part | ![[filename#heading]] |
![](filename#heading) |
Cite a block | ![[filename#^blockid]] |
![](filename#^blockid) |
CSS
The plugin will create :
- A link to the original file, with the form of :
<a href="original link" class="link_citation"><i class='fas fa-link'></i></a>
- A div with the founded content :
<div class="citation">content founded</div>
- In case of the link / contents is not found :
<div class="not_found">filename#part</div>
You can add a css in your docs/assets/css
(or whatever the path is), and add it to your mkdocs.yml
:
extra_css:
- assets/css/embed_link.css
You can find an example of custom css in docs
Limitation
- The embed file don't use plugin you would use.
- Wikilinks ambiguity are not supported : the first file with the name are used.
Credit
Thanks to midnightprioriem for the tooltip plugin.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_embed_file_plugins-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3badb7fafa5ac0a00bbef85a8f405695dae1e4488b3a7aed61a35f6889086fe6 |
|
MD5 | 01179d4eb9a8a3a296ded48b509319d3 |
|
BLAKE2b-256 | 3851649d6f55541d9269fd3b42ce25b35f992eda86ee358ab390ddfc5272e44a |
Close
Hashes for mkdocs_embed_file_plugins-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 897198f9c13468747f05116ea80abbbb1c4baa0e07c0edc949bb7c263ef58505 |
|
MD5 | 54b95d070d0843ada9b7b8a7190e8e3b |
|
BLAKE2b-256 | 1f2811329b71bf9e59297ea0041e79fee9c887c62db63779396e47f2a16847c4 |