@@ -12,17 +12,20 @@ Intended to be used by obsidian user.
12
12
``` yaml
13
13
plugins :
14
14
- search
15
- - embed_file
15
+ - embed_file
16
16
` ` `
17
17
3. [Override](https://www.mkdocs.org/user-guide/customizing-your-theme/) your ` main.html` with :
18
18
` ` ` html
19
19
{% extends "base.html" %}
20
20
{% block extrahead %}
21
-
21
+
22
22
<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">
23
23
{% endblock %}
24
24
` ` `
25
25
26
+ > [!IMPORTANT]
27
+ > You need to set the `site_url` in the `mkdocs.yml` to make the plugin work.
28
+
26
29
# Usage
27
30
28
31
| Usage | wikilinks | markdown links |
@@ -39,18 +42,18 @@ The plugin will create :
39
42
- In case of the link / contents is not found the following block is created instead :
40
43
` ` ` html
41
44
<div class='citation'><a class='link_citation'><i class='fas fa-link'></i></a><p style="text-align: center; display: block"><i class="not_found"> link_alt </i> {a configured message}</p></div>
42
- ` ` `
45
+ ` ` `
43
46
The message for the not found file can be customized in `mkdocs.yml`. The default message is `file not exists`.
44
47
45
48
You can add a css in your `docs/assets/css` (or whatever the path is), and add it to your `mkdocs.yml` :
46
- ` ` ` yml
49
+ ` ` ` yml
47
50
extra_css:
48
51
- assets/css/embed_link.css
49
52
` ` `
50
53
You can find an example of custom css in [docs](docs/embed_link.css)
51
54
52
55
# Configuration
53
- If you want, you can add compatibility with :
56
+ If you want, you can add compatibility with :
54
57
- [mkdocs callouts](https://github.com/sondregronas/mkdocs-callouts)
55
58
- [mkdocs custom tags attributes](https://github.com/Mara-Li/mkdocs-custom-tags-attributes)
56
59
@@ -79,4 +82,4 @@ Note : Every extension set in `markdown_extensions` will be used for the convert
79
82
- Wikilinks ambiguity are not supported : the first file with the name are used.
80
83
81
84
# Credit
82
- Thanks to [midnightprioriem](https://github.com/midnightprioriem/mkdocs-tooltipster-links-plugin) for the tooltip plugin.
85
+ Thanks to [midnightprioriem](https://github.com/midnightprioriem/mkdocs-tooltipster-links-plugin) for the tooltip plugin.
0 commit comments