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, as wikilinks for example.
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.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 548b36ab6128cd5cd7f0042f74e495b61dd403738890fdd78986a566981afedd |
|
MD5 | 75032846193f87441f56ae251a92268a |
|
BLAKE2b-256 | facfc10059829dbb1746df2634ab1438f60a2ee8dc12312c92d4d54c0afed1ed |
Close
Hashes for mkdocs_embed_file_plugins-1.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10957c42ad77647fb42498bd308b15d38b50758f3ac3992dbc6fce4f6d2d4957 |
|
MD5 | cf7f5f6543f9f487dbc3082f3bbe6198 |
|
BLAKE2b-256 | 579772fad6e4aa01f16421e03774a77674d52944c22fc622fa11bc6f5a1fbf15 |