Skip to content

Commit 31bff58

Browse files
committed
chore: update pyproject & readme
1 parent 27fb0bf commit 31bff58

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,20 @@ Intended to be used by obsidian user.
1212
```yaml
1313
plugins:
1414
- search
15-
- embed_file
15+
- embed_file
1616
```
1717
3. [Override](https://www.mkdocs.org/user-guide/customizing-your-theme/) your `main.html` with :
1818
```html
1919
{% extends "base.html" %}
2020
{% block extrahead %}
21-
21+
2222
<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">
2323
{% endblock %}
2424
```
2525

26+
> [!IMPORTANT]
27+
> You need to set the `site_url` in the `mkdocs.yml` to make the plugin work.
28+
2629
# Usage
2730

2831
| Usage | wikilinks | markdown links |
@@ -39,18 +42,18 @@ The plugin will create :
3942
- In case of the link / contents is not found the following block is created instead :
4043
```html
4144
<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+
```
4346
The message for the not found file can be customized in `mkdocs.yml`. The default message is `file not exists`.
4447

4548
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
4750
extra_css:
4851
- assets/css/embed_link.css
4952
```
5053
You can find an example of custom css in [docs](docs/embed_link.css)
5154

5255
# Configuration
53-
If you want, you can add compatibility with :
56+
If you want, you can add compatibility with :
5457
- [mkdocs callouts](https://github.com/sondregronas/mkdocs-callouts)
5558
- [mkdocs custom tags attributes](https://github.com/Mara-Li/mkdocs-custom-tags-attributes)
5659

@@ -79,4 +82,4 @@ Note : Every extension set in `markdown_extensions` will be used for the convert
7982
- Wikilinks ambiguity are not supported : the first file with the name are used.
8083

8184
# 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.

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ commit_parser = "angular"
55
logging_use_named_masks = false
66
major_on_zero = true
77
tag_format = "v{version}"
8-
version_variable = "setup.py:version"
8+
version_variables = ["setup.py:version"]
9+
build_command = "python setup.py sdist bdist_wheel"
910

1011
[tool.semantic_release.branches.main]
1112
match = "(main|master)"

0 commit comments

Comments
 (0)