FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Commit bcb05387 authored by Nick Brown's avatar Nick Brown
Browse files

feat: Added macros/utils define_env and site_url macro definition

parent 610ff1a8
No related branches found
No related tags found
1 merge request!453feat: Knowledge base enhancements (diataxis)
......@@ -11,7 +11,7 @@ import re
import yaml
from mkdocs_macros.plugin import MacrosPlugin
from . import (diagram, gitlab, services, table)
from . import (diagram, gitlab, services, table, utils)
from .constants import TEMPLATE_VARIABLES
def define_env(env: MacrosPlugin):
......@@ -27,3 +27,4 @@ def define_env(env: MacrosPlugin):
gitlab.define_env(env)
services.define_env(env)
table.define_env(env)
utils.define_env(env)
......@@ -3,6 +3,8 @@
from mkdocs_macros.plugin import MacrosPlugin
from urllib.parse import urljoin
# Utilities:
def environment(env: MacrosPlugin) -> dict:
"""
Useful for debugging & development.
......@@ -26,3 +28,17 @@ def variables(env: MacrosPlugin) -> dict:
def rel_url(env: MacrosPlugin, rel_path: str) -> str:
site_url = environment(env)["conf"]["site_url"]
return urljoin(site_url, rel_path)
# Generic Macros:
_ENV = None
def define_env(env: MacrosPlugin):
global _ENV
_ENV = env
env.macro(site_url)
def site_url() -> str:
env = environment(_ENV)
return env["conf"]["site_url"]
#return environment(_ENV)["conf"]["site_url"]
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment