From ac91ccd560d7a2e3917fc51caaa250cc6ef93583 Mon Sep 17 00:00:00 2001 From: Philipp Temminghoff Date: Sun, 17 Sep 2023 20:44:24 +0200 Subject: [PATCH] chore: docs --- mknodes/info/folderinfo.py | 1 + mknodes/navs/navrouter.py | 10 +++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/mknodes/info/folderinfo.py b/mknodes/info/folderinfo.py index b80c64b1..020c7356 100644 --- a/mknodes/info/folderinfo.py +++ b/mknodes/info/folderinfo.py @@ -34,6 +34,7 @@ "docker.com": "fontawesome/brands/docker", "fosstodon.org": "fontawesome/brands/mastodon", "discord.gg": "fontawesome/brands/discord", + "discord.com": "fontawesome/brands/discord", "linkedin.com": "fontawesome/brands/linkedin", "dev.to": "fontawesome/brands/dev", "medium.to": "fontawesome/brands/medium", diff --git a/mknodes/navs/navrouter.py b/mknodes/navs/navrouter.py index 2618ec47..eaea89f7 100644 --- a/mknodes/navs/navrouter.py +++ b/mknodes/navs/navrouter.py @@ -39,7 +39,6 @@ def __call__( In comparison to `page()` and `nav()`, it is not required to know in advance what will be returned. - Arguments: path: The section path for the returned `MkNav` / `MkPage` show_source: If True, a section containing the code will be inserted @@ -84,6 +83,10 @@ def nav( There is also the possibility to create a new MkNav and return it in the decorated method, that MkNav takes preference then over the modified one. + Examples: + @nav.route.nav("Routed nav") + def _(nav: mk.MkNav): + nav += ... Arguments: path: The section path for the returned MkNav @@ -129,6 +132,11 @@ def page( There is also the possibility to create a new MkPage and return it in the decorated method, that MkPage takes preference then over the modified one. + Examples: + @nav.route.page("Routed page", icon=...) + def _(page: mk.MkPage): + page += ... + Arguments: path: The section path for the returned MkPage show_source: If True, a section containing the code will be inserted