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 - roamlinks - embed_file
(the plugin have a dependency to roamlinks) - 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.
- Image wikilinks are formated as links. At last you can click on it :D
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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82f374205261bfda191f9458440a02316db281d6a59ef9c6f5c4f4343c30ad45 |
|
MD5 | d0e40ad3687f80f89cedffc2f44a2409 |
|
BLAKE2b-256 | 07596538aca2bb881fd9e87e527c5d635f860e46a476ad129c682a024ff142f4 |
Close
Hashes for mkdocs_embed_file_plugins-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 792562bfeb805150dbe04cabff0b70eea80a3f674e114b9e571809faedd21eaf |
|
MD5 | a5e2b8feaab393c35ca56ffc040ac4d7 |
|
BLAKE2b-256 | 323ef35ffaab6c21963bd5b8fd9167eb231c598a992ba2a915f3767421bf27b4 |