How to config custom key-value pairs in mkdocs.yml ?

[wanzhenchn]

I want to add NEW key-value pairs (like pdf_url) in mkdocs.yml, for example,

repo_url: http://xxxxxx
pdf_url: http://xxxxxx

however, the

mkdocs build --strict

shows that WARNING - Config value 'pdf_url': Unrecognised configuration name: pdf_url.

So how to config custom key-value pairs in mkdocs.yml ?

[kamilkrzyskow]

The repo_url is a predefined setting of the MkDocs configuration file. As far as I know, you cannot add more global key value pairs there without changing how it works. However, there is the extra key, which allows to add any keys under there.
Like so:

extra:
    pdf_url: http://xxxxxx/

and then in your Jinja2 HTML template you can do something like this:

<a href="{{ config.extra.pdf_url }}">Download the PDF</a>

or maybe you want to have access to those variables in the Markdown, then maybe the macros plugin can help you.

https://www.mkdocs.org/user-guide/configuration/#extra
https://mkdocs-macros-plugin.readthedocs.io/en/latest/

[wanzhenchn]

Right, many thanks.