CI/CD-Komponenten
Diese Referenz wird automatisch aus den CI-Template-Dateien generiert.
md-to-web
Quelle: md-to-web.yml
| Input | Typ | Default | Beschreibung |
|---|---|---|---|
| md-path | string | document | The path to the markdown dir (e.g. document) |
| document-title | string | Document | The title of the document |
| deploy-only-on | string | tags | The ref to deploy the page on. Can be a branch name or 'tags'. If you want to deploy only on tags use 'tags'. |
| footer-copyright | string | "" | The footer copyright text |
| umbrella-brand | string | false | If true, the umbrella brand header will be displayed |
| encrypt-page | string | false | If true, the page will be encrypted with a password (please provide the password via the env variable ENCRYPT_PASSWORD) |
| enable-self-assessment | string | false | If true, the self-assessment feature will be enabled. |
| theme | string | kernux | The theme to use for the web book. Can be 'kernux', 'bund' or 'opencode'. |
| logo-path | string | "" | The (relative) path to the logo image (svg, png, jpg) to use in the header (e.g. 'dokument/assets/logo.png') |
| logo-path-dark-mode | string | "" | The (relative) path to the logo image (svg, png, jpg) to use in the header in dark mode (e.g. 'dokument/assets/logo-dark.png') |
| logo-height | string | "" | Height of the navbar logo as a CSS value (e.g. '3rem', '64px'). Leave empty for the default (3rem). |
| footer-logo-path | string | "" | The (relative) path to the footer logo image (svg, png, jpg) to use in the footer (e.g. 'dokument/assets/footer-logo.png') |
| feedback-server-url | string | "" | The URL of the feedback server (enables feedback feature). If not set, the feedback feature will be disabled. |
| feedback-description | string | 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 | string | Geben Sie uns Feedback | Title for the feedback form. |
| feedback-confidential-issue | string | false | If true, the feedback issue will be created as confidential issue (only visible for project members) in GitLab. |
| repository-url | string | "" | The URL of the repository. If set a link to the repository will be added next to the search bar. |
| hide-glossary-page-in-menu | string | false | If true, the generated glossary page will be hidden in the menu. |
| header-lower-badge-logo-path | string | "" | The (relative) path to the logo image (svg, png, jpg) to be displayed on the lower edge of the header (e.g. 'dokument/assets/some-logo.png') |
| copy-to-public-dir | string | "" | A paths (relative) to copy to the public directory. Useful for copying assets like custom favicons. |
| hide-commit-in-title | string | false | If true, the commit hash will not be appended to the document title. |
| multi-language-locales | string | "" | Comma-separated list of locales for multi-language support (e.g. 'en,de'). If empty, single-language mode is used. |
| multi-language-default-locale | string | de | Default locale for multi-language support (e.g. 'de'). Only used when multi-language-locales is set. |
| default-locale | string | "" | Locale for single-language projects (e.g. 'en'). Sets the html lang attribute and the UI language. Ignored when multi-language-locales is set. If empty, 'de' is used. |
| markdown-webbook-version | string | 2.2.0 | The version of the @document-writing-tools/markdown-webbook package to use (e.g. '2.2.0') |
| disable-toc | string | false | If true, the table of contents will be disabled on all pages. |
link-checker
Quelle: link-checker.yml
| Input | Typ | Default | Beschreibung |
|---|---|---|---|
| url | string | "" | Optional: URL to check for remote link checking. If not provided, local scanning will be used. (notable variable: $CI_PAGES_URL) |
| scanpath | string | ./ | Path to scan for local link checking (used when url is not provided) |
| flags | string | --no-progress --timeout 10 --max-concurrency 4 | Command line flags for lychee |
| stage | string | tests | The pipeline stage for the job |
| allow_failure | boolean | false | Whether the job is allowed to fail without stopping the pipeline |
accessibility-checker
Quelle: accessibility-checker.yml
| Input | Typ | Default | Beschreibung |
|---|---|---|---|
| url | string | $CI_PAGES_URL | Input the url you want to check for accessibility |