diff --git a/README.md b/README.md index 12cbf24..82c4c94 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io). In order to not break links of posts, blog articles and shared documents we want to provide full backwards-compatibility. This means we need to ensure existing links still work with the new documentation. -The file /static/_redirects contains a list of all paths of the old docs-sites. The file is formatted to create server-side-redirects on netlify, following the documentation here: https://docs.netlify.com/routing/redirects/ +The file /static/\_redirects contains a list of all paths of the old docs-sites. The file is formatted to create server-side-redirects on netlify, following the documentation here: https://docs.netlify.com/routing/redirects/ ## Docs @@ -71,7 +71,6 @@ slug: /your-doc-url title: Title of document position: --- - ``` @@ -87,7 +86,11 @@ This file is used to generate the sidebar. } ``` -## Embedding drawio images +## Images and svgs + +When adding images, SVGs, or similar assets, ensure they remain readable in both dark and light mode. For images containing text, consider adding a background to improve contrast and overall readability. + +### Embedding drawio images > ⚠️ referenced `.drawio.svg` images throw **warnings** because of unsupported file-types. We save `.drawio` files separately and export them as `svg`. Issue is also known in [docusaurus](https://github.com/facebook/docusaurus/issues/9715) @@ -113,10 +116,9 @@ type: "blog" categories: - "Conferences" tags: - - 'News' - - 'Conferences' + - "News" + - "Conferences" --- - @@ -154,13 +156,13 @@ All components are referenced in the `/scripts/components.json` file. Use this m ```jsonc { - "name": "metalctl", // name of the component, will appear in the navigation - "releasePath": "binaries.metal-stack.metalctl.version", // json-path of the version or tag in the release-vector - "branch": "main", // branch name. Some old repositories use 'master' - "repo": "metal-stack/metalctl", // component repository, - "tag": "v0.18.1", // latest release tag of the component repository - "position": 1, // use this property to sort the navigation subdirectories - "withDocs": true // set to true to retrieve further .md files from a /docs folder. With false, only the README.md will be retrieved. + "name": "metalctl", // name of the component, will appear in the navigation + "releasePath": "binaries.metal-stack.metalctl.version", // json-path of the version or tag in the release-vector + "branch": "main", // branch name. Some old repositories use 'master' + "repo": "metal-stack/metalctl", // component repository, + "tag": "v0.18.1", // latest release tag of the component repository + "position": 1, // use this property to sort the navigation subdirectories + "withDocs": true // set to true to retrieve further .md files from a /docs folder. With false, only the README.md will be retrieved. } ``` @@ -187,4 +189,5 @@ To run the synchronization, run the following command: ```bash bun run create-release-notes ``` + If you run this before the build step, also the release notes get indexed. diff --git a/src/css/custom.css b/src/css/custom.css index bfa9789..5ee4be1 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -56,6 +56,11 @@ html[data-theme="dark"] { --ifm-background-color: var(--color-neutral-950); --ifm-background-surface-color: var(--color-neutral-950); + +} + +html[data-theme="dark"] p img { + background-color:#f5f5f57f; } body { @@ -115,6 +120,10 @@ p { @apply text-base text-neutral-500 dark:text-neutral-400 leading-relaxed; } +ul, ol { + @apply text-neutral-500 dark:text-neutral-400 ; +} + a { @apply text-amber-500; }