homer77
/
lektor-citation
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Updated the README.md

This commit is contained in:
Homer S. 2022-01-27 22:00:58 +01:00
parent af095b8d32
commit 958829885d
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -15,6 +15,10 @@ Create an _citation.ini_ in its _configs_-folder:
```
[Bibtex]
file = Literature.bib
[default]
priority = url
link = /for-example/link-to-your/biblioprahy
```
And put a _Literature.bib_ BibTex-file into the project's _assets_-folder respectively.
@ -94,5 +98,11 @@ Both methods create a complete hyperlink inside your text for the entry with _id
or
(AuthorI & AuthorII, 2019)
#### link parameter
Which url is used for your citation's link depends on what you set in the _citation.ini_ file.
* If you set _priority_ in the _default_ section to __url__ the link is set to the value of the _url_ field of the entry.
* If there's no value in it the default-link you may set with _link_ in the same section is used.
* If you set the _link_ parameter of the function it overwrites the former options.
Thanks to the **lektor-jinja-content** plugin which is a dependency of this plugin you might also use the globals inside your markdown or html contents, too.