Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
phil65 committed Sep 17, 2023
1 parent acb3d3b commit ac91ccd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
1 change: 1 addition & 0 deletions mknodes/info/folderinfo.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
10 changes: 9 additions & 1 deletion mknodes/navs/navrouter.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ac91ccd

Please sign in to comment.