From f7ad1d6816ab28dd28138e79dd87d2d8f3b445db Mon Sep 17 00:00:00 2001 From: Philipp Temminghoff Date: Sat, 16 Sep 2023 05:09:20 +0200 Subject: [PATCH] chore: docs --- mknodes/manual/cli_section.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/mknodes/manual/cli_section.py b/mknodes/manual/cli_section.py index bbd2dcde..92851ab7 100644 --- a/mknodes/manual/cli_section.py +++ b/mknodes/manual/cli_section.py @@ -2,10 +2,14 @@ INTRO_TEXT = """MkNodes offers a CLI interface in order to build projects based on -Callables. The CLI is closely aligned to the MkDocs CLI to simplify the usage. +Callables. The CLI is closely aligned to the MkDocs CLI to simplify the usage. Most +arguments have the same name. +""" -MkNodes CLI is based on Typer and uses a RichHandler for log output. +INFO_BOX = """The biggest technical difference compared to MkDocs CLI: +MkNodes CLI is based on `Typer` and uses a log handler from `rich` for log output.""" +EXPLANATION_TEXT = """ There are 3 diffent commands right now: - `mknodes build`: Closely aligned to `mkdocs build`, but with the option to point @@ -37,6 +41,8 @@ def create_cli_section(root_nav: mk.MkNav): page = nav.add_index_page(hide_toc=True, icon="octicons/command-palette-16") page += mk.MkBinaryImage.for_file("docs/assets/cli.gif") page += INTRO_TEXT + page += mk.MkAdmonition(INFO_BOX) + page += EXPLANATION_TEXT code = mk.MkCode.for_object(create_cli_section) page += mk.MkAdmonition(code, title=SECTION_CODE, collapsible=True, typ="quote")