Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -71,7 +71,6 @@ slug: /your-doc-url
title: Title of document
position: <Position in sidebar as number>
---

<HERE YOUR DOCS>
```

Expand All @@ -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)

Expand All @@ -113,10 +116,9 @@ type: "blog"
categories:
- "Conferences"
tags:
- 'News'
- 'Conferences'
- "News"
- "Conferences"
---

<SOME PREVIEW TEXT FOR BLOG LIST VIEW>

<!-- truncate -->
Expand Down Expand Up @@ -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.
}
```

Expand All @@ -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.
9 changes: 9 additions & 0 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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;
}
Expand Down