Add YAML placeholder tags that resolve to current paths

[oprypin]

• Closes Support for relative base_path in markdown_extensions #2154

- !relative  # Obtains the directory of the currently rendered Markdown file
- !relative $config_dir  # Obtains the directory of mkdocs.yml
- !relative $docs_dir  # Obtains the docs_dir
- !relative $docs_dir/some/child/dir

[oprypin]

Tagging @facelessuser now also on the pull request for any comments. Now I actually mention pymdownx.snippets directly in docs.

[squidfunk]

Could we allow plugins to register custom YAML tags? I suspect that this would need to be implemented outside of the plugin, because when the plugin is loaded, the configuration has already been parsed, but maybe plugins could provide something like a loader.py file that MkDocs checks and executes before parsing the configuration 😊

[oprypin]

There's no clear technical solution how to do that (see also #3261), no known use case, and so no plan to do that

[squidfunk]

It would be very helpful for the new projects plugin in Material for MkDocs to define tags to inline navigation from projects into the top-level site and other custom tags for additional features. From the top of my head: If a project defines an __init__.py or loaders.py next to mkdocs.yml, include that before attempting to parse the configuration.

That'll work, wouldn't it?

Edit: okay, the author would need to add the __init__.py then, which is odd. Hmm, is there really no way?

[oprypin]

That sounds like not something that would require tags to function. Instead of - !foo bar you could just define - foo: bar or something. Feel free to open a discussion if you want to figure out a way to achieve something in the configs.

[squidfunk]

Thanks, I'll think a little about this and might open a dedicated discussion.