serve

Serve a MkNodes-based website, locally or remotely.

Runs the build script on given repository (either locally or a hosted one), adapts the config file automatically and serves a webpage on http://127.0.0.1/8000/.

Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/

mknodes serve [OPTIONS]

--repo-url, -r

Repository URL of the target package. Can be remote or local.

--build-fn, -b

Path to the build script. (form: path.to.module:function )

--clone-depth, -c

Git clone depth in case repository is remote. Important for changelog generation.

--config-path, -p

Default: mkdocs.yml Path to the config file.

--strict, -s

Flag Strict mode (fails on warnings)

--theme, -t

Default: material Theme to use for the build. Overrides config setting.

-u, --use-directory-urls

Default: True Flag Use directory-style URLs.

--verbose, -v

Flag Enable verbose output. (DEBUG level)

--quiet, -q

Flag Suppress output during build.

--help

Flag Show this message and exit.

Page info

Code for this page

mkdocs_mknodes.manual.cli_section._
@nav.route.page("serve", icon="web")
def _(page: mk.MkPage):
    page += mk.MkCliDoc(CLI_PATH, prog_name="serve")

Resources

Resources(css=[],
          markdown_extensions={'attr_list': {},
                               'md_in_html': {},
                               'pymdownx.emoji': {'emoji_generator': <function to_svg at 0x7f170970c540>,
                                                  'emoji_index': <function twemoji at 0x7f170970c400>},
                               'pymdownx.magiclink': {'repo': 'mkdocs_mknodes',
                                                      'repo_url_shorthand': True,
                                                      'user': 'phil65'}},
          plugins=[],
          js=[],
          assets=[Asset('materialbadge_31c4bf6.css')],
          packages=[])

Metadata

created:
  source_filename: /home/runner/work/mkdocs-mknodes/mkdocs-mknodes/mkdocs_mknodes/manual/cli_section.py
  source_function: null
  source_line_no: 21
icon: material/web
template: CLI/serve.html
title: serve