---
created:
  source_filename: /home/runner/work/mkdocs-mknodes/mkdocs-mknodes/.venv/lib/python3.13/site-packages/anyenv/async_run.py
  source_function: run_sync.<locals>.wrapper
  source_line_no: 52
icon: material/web
title: serve
---

## 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/

``` {.python }
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`

<span class="md-typeset mdx-badge">
  <span class="mdx-badge__icon">:mdi-flag:</span>
  <span class="mdx-badge__text">Flag</span>
</span>
Strict mode (fails on warnings)


### `--theme`, `-t`

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


### `-u`, `--use-directory-urls`

**Default:** True
<span class="md-typeset mdx-badge">
  <span class="mdx-badge__icon">:mdi-flag:</span>
  <span class="mdx-badge__text">Flag</span>
</span>
Use directory-style URLs.


### `--verbose`, `-v`

<span class="md-typeset mdx-badge">
  <span class="mdx-badge__icon">:mdi-flag:</span>
  <span class="mdx-badge__text">Flag</span>
</span>
Enable verbose output. (`DEBUG` level)


### `--quiet`, `-q`

<span class="md-typeset mdx-badge">
  <span class="mdx-badge__icon">:mdi-flag:</span>
  <span class="mdx-badge__text">Flag</span>
</span>
Suppress output during build.


### `--help`

<span class="md-typeset mdx-badge">
  <span class="mdx-badge__icon">:mdi-flag:</span>
  <span class="mdx-badge__text">Flag</span>
</span>
Show this message and exit.