Markdown Webbook CLI
Diese Referenz wird automatisch aus der CLI-Implementierung generiert.
| Flag | Erforderlich | Default | Beschreibung |
|---|---|---|---|
| -V / --version | false | — | output the version number |
| -i / --input | true | — | Input directory containing markdown files |
| -o / --output | false | — | Output directory for static HTML files |
| -b / --build-directory | false | — | Directory for intermediate build files |
| -w / --watch | false | false | Start development server with file watching |
| --theme | false | kernux | The theme to apply - possible values: "bund" | "kernux" | "opencode" | "opendesk". Defaults to "kernux" |
| --title | false | "" | Title of the webbook. Rendered inside the navbar. Can be empty. |
| --dachmarke | false | false | Enable Dachmarke in the header and footer (https://www.digitale-verwaltung.de/Webs/DV/DE/aktuelles-service/digitale_dachmarke/digitale_dachmarke-node.html). |
| --feedback-gitlab-project-id | false | — | GitLab project ID for feedback |
| --feedback-server-url | false | — | Feedback server URL (https://gitlab.opencode.de/open-code/document-writing-tools/feedback-server) |
| --feedback-issue-link | false | — | Link to gitlab issue page. Example: https://gitlab.opencode.de/servicestandard/website/-/issues. |
| --feedback-description | false | Ihr Feedback hilft uns, die Website an den Bedürfnissen der Nutzenden auszurichten. Beschreiben Sie Ihr Anliegen so detailliert wie möglich. Geben Sie keine persönlichen Daten ein. | Description text for the feedback form. Only the text inside the P tag. |
| --feedback-title | false | Geben Sie uns Feedback | Title for the feedback form. |
| --feedback-confidential-issue | false | false | Create feedback issues as confidential GitLab issues. When enabled, the public-visibility notice is hidden from the feedback form. |
| --logo-path | false | — | Path to the logo image file (svg, png, jpg) |
| --logo-path-dark-mode | false | — | Path to an optional logo image file (svg, png, jpg) shown in dark mode. Requires --logo-path. The light-mode logo is used when this is not set. |
| --logo-height | false | — | Height of the navbar logo as a CSS value (e.g. "3rem", "64px"). Defaults to 3rem. |
| --footer-logo-path | false | — | Path to the footer logo image file (svg, png, jpg) |
| --copyright | false | "" | Copyright notice to display in the footer |
| --repository-url | false | — | URL to the source code repository. If set, a small openCode icon will be rendered inside the navbar linking to the repository. |
| --matomo-url | false | — | Base URL of the Matomo instance |
| --matomo-site-id | false | — | Matomo site ID |
| --matomo-privacy-url | false | — | URL or path to the privacy policy linked from the cookie banner |
| --selfassessment | false | false | Enable self-assessment functionality |
| --hide-glossary-page-in-menu | false | false | Hide glossary page in menu |
| --disable-toc | false | false | Disable the table of contents globally for all pages. Per-page "disableToc: true" frontmatter still works independently. |
| --header-lower-badge-logo-path | false | — | Path to the logo image file (svg, png, jpg) shown in the lower header area. |
| --copy-to-public-dir | false | — | Path to a directory containing files to copy to the public directory (e.g. favicons, security.txt, etc.) |
| --multi-language-locales | false | [function] | Comma-separated list of locales for multi-language support (e.g. "en,de") |
| --multi-language-default-locale | false | de | Default locale for multi-language support (e.g. "de") |
| --enable-live-editor | false | true | Add the live editor page (/preview) and the OAuth2 callback page (/oauth2/callback) |
| --private-mode | false | true | Publish only the live editor: no content pages are built, so the document is readable for logged in users only |
| --connected-repo | false | — | Repository the live editor reads and writes (e.g. https://gitlab.opencode.de/group/repo). Defaults to --repository-url. |
| --cors-proxy | false | — | CORS proxy used by the live editor for git clone/push (e.g. https://example.com:9999) |
| --editor-subpath | false | — | Subdirectory inside the connected repository the live editor is scoped to |
| --editor-branch | false | main | Branch the live editor reads and writes. Defaults to "main". |
| --default-locale | false | de | Locale for single-language projects — sets the html lang attribute and the UI language (e.g. "en"). Ignored in multi-language mode. |
| -h / --help | false | — | display help for command |