fix: use prettier for formatting markdown (#10486)

* fix: use prettier for checking markdown

Since biome doesn't handle markdown yet, only svelte and code.

Restore the previous config, but skip "prettier-plugin-svelte".

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
This commit is contained in:
Anders Björklund 2024-12-30 13:41:13 +01:00 committed by GitHub
parent effc6f84e8
commit 3e8445e5b8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
30 changed files with 320 additions and 293 deletions

3
.prettierignore Normal file
View file

@ -0,0 +1,3 @@
website/api/
website/build/
website/node_modules/

7
.prettierrc Normal file
View file

@ -0,0 +1,7 @@
{
"bracketSameLine": true,
"singleQuote": true,
"arrowParens": "avoid",
"printWidth": 120,
"trailingComma": "all",
}

View file

@ -216,7 +216,7 @@ When contributing the new code, you should consider not lowering overall code co
### Step 7. Code formatter / linter
We use `@biomejs/biome` as a formatter and `eslint` for linting.
We use `@biomejs/biome` (and `prettier` for markdown) as formatter and `eslint` for linting.
Check that your code is properly formatted with the linter and formatter:
@ -316,7 +316,6 @@ Legal name must be used (no pseudonyms or anonymous contributions)
If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`.
### Skipping Jobs for Draft Pull Requests on GitHub
When creating a pull request in **draft mode** on GitHub, all CI/CD jobs are **skipped by default**. This behavior is intentional to avoid triggering unnecessary workflows while the pull request is still in progress.

View file

@ -72,8 +72,8 @@
"test:watch": "vitest watch",
"test:website": "vitest run -r website --passWithNoTests --coverage",
"watch": "node scripts/watch.mjs",
"format:check": "biome format",
"format:fix": "biome format --write",
"format:check": "biome format && prettier --cache --check \"website/**/*.md\"",
"format:fix": "biome format --write && prettier --cache --write \"website/**/*.md\"",
"markdownlint:check": "markdownlint-cli2 \"website/**/*.md\" \"#website/node_modules\" \"#website/api\"",
"markdownlint:fix": "markdownlint-cli2 --fix \"website/**/*.md\" \"#website/node_modules\"",
"lint:clean": "rimraf .eslintcache",
@ -112,7 +112,8 @@
"node --max-old-space-size=6144 node_modules/eslint/bin/eslint.js --cache --fix",
"biome format --write"
],
"*.{md,css,json}": "biome format --write"
"*.md": "prettier --cache --write",
"*.{css,json}": "biome format --write"
},
"devDependencies": {
"@biomejs/biome": "^1.9.4",
@ -167,6 +168,7 @@
"minimist": "^1.2.8",
"msw": "^2.7.0",
"postcss-import": "^16.1.0",
"prettier": "^3.3.3",
"proxy": "^2.2.0",
"typescript": "5.6.3",
"typescript-eslint": "^8.18.2",

View file

@ -267,6 +267,9 @@ importers:
postcss-import:
specifier: ^16.1.0
version: 16.1.0(postcss@8.4.49)
prettier:
specifier: ^3.3.3
version: 3.4.2
proxy:
specifier: ^2.2.0
version: 2.2.0
@ -803,28 +806,28 @@ importers:
devDependencies:
'@storybook/addon-essentials':
specifier: ^8.4.7
version: 8.4.7(@types/react@18.3.12)(storybook@8.4.4)
version: 8.4.7(@types/react@18.3.12)(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-interactions':
specifier: ^8.4.7
version: 8.4.7(storybook@8.4.4)
version: 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-links':
specifier: ^8.4.7
version: 8.4.7(react@18.2.0)(storybook@8.4.4)
version: 8.4.7(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-svelte-csf':
specifier: 5.0.0-next.11
version: 5.0.0-next.11(@storybook/svelte@8.4.7(storybook@8.4.4)(svelte@5.16.0))(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(storybook@8.4.4)(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
version: 5.0.0-next.11(@storybook/svelte@8.4.7(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0))(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
'@storybook/blocks':
specifier: ^8.4.7
version: 8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4)
version: 8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))
'@storybook/svelte':
specifier: ^8.4.7
version: 8.4.7(storybook@8.4.4)(svelte@5.16.0)
version: 8.4.7(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)
'@storybook/svelte-vite':
specifier: ^8.4.7
version: 8.4.7(@babel/core@7.26.0)(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(postcss-load-config@6.0.1(jiti@2.4.1)(postcss@8.4.49)(tsx@4.19.2)(yaml@2.6.1))(postcss@8.4.49)(storybook@8.4.4)(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
version: 8.4.7(@babel/core@7.26.0)(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(postcss-load-config@6.0.1(jiti@2.4.1)(postcss@8.4.49)(tsx@4.19.2)(yaml@2.6.1))(postcss@8.4.49)(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
'@storybook/test':
specifier: ^8.4.7
version: 8.4.7(storybook@8.4.4)
version: 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@sveltejs/package':
specifier: ^2.3.7
version: 2.3.7(svelte@5.16.0)(typescript@5.6.3)
@ -860,10 +863,10 @@ importers:
version: 18.3.1(react@18.2.0)
storybook:
specifier: ^8.2.9
version: 8.4.4
version: 8.4.4(prettier@3.4.2)
storybook-dark-mode:
specifier: ^4.0.2
version: 4.0.2(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4)
version: 4.0.2(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))
svelte:
specifier: 5.16.0
version: 5.16.0
@ -9314,6 +9317,11 @@ packages:
resolution: {integrity: sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==}
engines: {node: '>= 0.8.0'}
prettier@3.4.2:
resolution: {integrity: sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ==}
engines: {node: '>=14'}
hasBin: true
pretty-error@4.0.0:
resolution: {integrity: sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw==}
@ -14642,100 +14650,100 @@ snapshots:
micromark-util-character: 1.2.0
micromark-util-symbol: 1.1.0
'@storybook/addon-actions@8.4.7(storybook@8.4.4)':
'@storybook/addon-actions@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
'@types/uuid': 9.0.8
dequal: 2.0.3
polished: 4.3.1
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
uuid: 9.0.1
'@storybook/addon-backgrounds@8.4.7(storybook@8.4.4)':
'@storybook/addon-backgrounds@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
memoizerific: 1.11.3
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
'@storybook/addon-controls@8.4.7(storybook@8.4.4)':
'@storybook/addon-controls@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
dequal: 2.0.3
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
'@storybook/addon-docs@8.4.7(@types/react@18.3.12)(storybook@8.4.4)':
'@storybook/addon-docs@8.4.7(@types/react@18.3.12)(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@mdx-js/react': 3.1.0(@types/react@18.3.12)(react@18.2.0)
'@storybook/blocks': 8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4)
'@storybook/csf-plugin': 8.4.7(storybook@8.4.4)
'@storybook/react-dom-shim': 8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4)
'@storybook/blocks': 8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))
'@storybook/csf-plugin': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/react-dom-shim': 8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))
react: 18.2.0
react-dom: 18.3.1(react@18.2.0)
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
transitivePeerDependencies:
- '@types/react'
'@storybook/addon-essentials@8.4.7(@types/react@18.3.12)(storybook@8.4.4)':
'@storybook/addon-essentials@8.4.7(@types/react@18.3.12)(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/addon-actions': 8.4.7(storybook@8.4.4)
'@storybook/addon-backgrounds': 8.4.7(storybook@8.4.4)
'@storybook/addon-controls': 8.4.7(storybook@8.4.4)
'@storybook/addon-docs': 8.4.7(@types/react@18.3.12)(storybook@8.4.4)
'@storybook/addon-highlight': 8.4.7(storybook@8.4.4)
'@storybook/addon-measure': 8.4.7(storybook@8.4.4)
'@storybook/addon-outline': 8.4.7(storybook@8.4.4)
'@storybook/addon-toolbars': 8.4.7(storybook@8.4.4)
'@storybook/addon-viewport': 8.4.7(storybook@8.4.4)
storybook: 8.4.4
'@storybook/addon-actions': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-backgrounds': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-controls': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-docs': 8.4.7(@types/react@18.3.12)(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-highlight': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-measure': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-outline': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-toolbars': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/addon-viewport': 8.4.7(storybook@8.4.4(prettier@3.4.2))
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
transitivePeerDependencies:
- '@types/react'
'@storybook/addon-highlight@8.4.7(storybook@8.4.4)':
'@storybook/addon-highlight@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/addon-interactions@8.4.7(storybook@8.4.4)':
'@storybook/addon-interactions@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
'@storybook/instrumenter': 8.4.7(storybook@8.4.4)
'@storybook/test': 8.4.7(storybook@8.4.4)
'@storybook/instrumenter': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/test': 8.4.7(storybook@8.4.4(prettier@3.4.2))
polished: 4.3.1
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
'@storybook/addon-links@8.4.7(react@18.2.0)(storybook@8.4.4)':
'@storybook/addon-links@8.4.7(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/csf': 0.1.11
'@storybook/global': 5.0.0
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
optionalDependencies:
react: 18.2.0
'@storybook/addon-measure@8.4.7(storybook@8.4.4)':
'@storybook/addon-measure@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
tiny-invariant: 1.3.3
'@storybook/addon-outline@8.4.7(storybook@8.4.4)':
'@storybook/addon-outline@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
'@storybook/addon-svelte-csf@5.0.0-next.11(@storybook/svelte@8.4.7(storybook@8.4.4)(svelte@5.16.0))(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(storybook@8.4.4)(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))':
'@storybook/addon-svelte-csf@5.0.0-next.11(@storybook/svelte@8.4.7(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0))(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))':
dependencies:
'@storybook/csf': 0.1.11
'@storybook/docs-tools': 8.4.4(storybook@8.4.4)
'@storybook/node-logger': 8.4.4(storybook@8.4.4)
'@storybook/svelte': 8.4.7(storybook@8.4.4)(svelte@5.16.0)
'@storybook/types': 8.4.4(storybook@8.4.4)
'@storybook/docs-tools': 8.4.4(storybook@8.4.4(prettier@3.4.2))
'@storybook/node-logger': 8.4.4(storybook@8.4.4(prettier@3.4.2))
'@storybook/svelte': 8.4.7(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)
'@storybook/types': 8.4.4(storybook@8.4.4(prettier@3.4.2))
'@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
dedent: 1.5.3
es-toolkit: 1.27.0
@ -14749,46 +14757,46 @@ snapshots:
- babel-plugin-macros
- storybook
'@storybook/addon-toolbars@8.4.7(storybook@8.4.4)':
'@storybook/addon-toolbars@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/addon-viewport@8.4.7(storybook@8.4.4)':
'@storybook/addon-viewport@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
memoizerific: 1.11.3
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/blocks@8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4)':
'@storybook/blocks@8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/csf': 0.1.11
'@storybook/icons': 1.2.12(react-dom@18.3.1(react@18.2.0))(react@18.2.0)
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
optionalDependencies:
react: 18.2.0
react-dom: 18.3.1(react@18.2.0)
'@storybook/builder-vite@8.4.7(storybook@8.4.4)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))':
'@storybook/builder-vite@8.4.7(storybook@8.4.4(prettier@3.4.2))(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))':
dependencies:
'@storybook/csf-plugin': 8.4.7(storybook@8.4.4)
'@storybook/csf-plugin': 8.4.7(storybook@8.4.4(prettier@3.4.2))
browser-assert: 1.2.1
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
ts-dedent: 2.2.0
vite: 6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)
'@storybook/components@8.4.4(storybook@8.4.4)':
'@storybook/components@8.4.4(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/components@8.4.7(storybook@8.4.4)':
'@storybook/components@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/core-events@8.4.4(storybook@8.4.4)':
'@storybook/core-events@8.4.4(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/core@8.4.4':
'@storybook/core@8.4.4(prettier@3.4.2)':
dependencies:
'@storybook/csf': 0.1.11
better-opn: 3.0.2
@ -14801,23 +14809,25 @@ snapshots:
semver: 7.6.3
util: 0.12.5
ws: 8.18.0
optionalDependencies:
prettier: 3.4.2
transitivePeerDependencies:
- bufferutil
- supports-color
- utf-8-validate
'@storybook/csf-plugin@8.4.7(storybook@8.4.4)':
'@storybook/csf-plugin@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
unplugin: 1.16.0
'@storybook/csf@0.1.11':
dependencies:
type-fest: 2.19.0
'@storybook/docs-tools@8.4.4(storybook@8.4.4)':
'@storybook/docs-tools@8.4.4(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/global@5.0.0': {}
@ -14826,41 +14836,41 @@ snapshots:
react: 18.2.0
react-dom: 18.3.1(react@18.2.0)
'@storybook/instrumenter@8.4.7(storybook@8.4.4)':
'@storybook/instrumenter@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/global': 5.0.0
'@vitest/utils': 2.1.6
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/manager-api@8.4.4(storybook@8.4.4)':
'@storybook/manager-api@8.4.4(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/manager-api@8.4.7(storybook@8.4.4)':
'@storybook/manager-api@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/node-logger@8.4.4(storybook@8.4.4)':
'@storybook/node-logger@8.4.4(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/preview-api@8.4.7(storybook@8.4.4)':
'@storybook/preview-api@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/react-dom-shim@8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4)':
'@storybook/react-dom-shim@8.4.7(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4(prettier@3.4.2))':
dependencies:
react: 18.2.0
react-dom: 18.3.1(react@18.2.0)
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/svelte-vite@8.4.7(@babel/core@7.26.0)(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(postcss-load-config@6.0.1(jiti@2.4.1)(postcss@8.4.49)(tsx@4.19.2)(yaml@2.6.1))(postcss@8.4.49)(storybook@8.4.4)(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))':
'@storybook/svelte-vite@8.4.7(@babel/core@7.26.0)(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1)))(postcss-load-config@6.0.1(jiti@2.4.1)(postcss@8.4.49)(tsx@4.19.2)(yaml@2.6.1))(postcss@8.4.49)(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))':
dependencies:
'@storybook/builder-vite': 8.4.7(storybook@8.4.4)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
'@storybook/svelte': 8.4.7(storybook@8.4.4)(svelte@5.16.0)
'@storybook/builder-vite': 8.4.7(storybook@8.4.4(prettier@3.4.2))(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
'@storybook/svelte': 8.4.7(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)
'@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.16.0)(vite@6.0.5(@types/node@22.9.1)(jiti@2.4.1)(terser@5.36.0)(tsx@4.19.2)(yaml@2.6.1))
magic-string: 0.30.13
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
svelte: 5.16.0
svelte-preprocess: 5.1.4(@babel/core@7.26.0)(postcss-load-config@6.0.1(jiti@2.4.1)(postcss@8.4.49)(tsx@4.19.2)(yaml@2.6.1))(postcss@8.4.49)(svelte@5.16.0)(typescript@5.6.3)
svelte2tsx: 0.7.26(svelte@5.16.0)(typescript@5.6.3)
@ -14880,14 +14890,14 @@ snapshots:
- sugarss
- supports-color
'@storybook/svelte@8.4.7(storybook@8.4.4)(svelte@5.16.0)':
'@storybook/svelte@8.4.7(storybook@8.4.4(prettier@3.4.2))(svelte@5.16.0)':
dependencies:
'@storybook/components': 8.4.7(storybook@8.4.4)
'@storybook/components': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/global': 5.0.0
'@storybook/manager-api': 8.4.7(storybook@8.4.4)
'@storybook/preview-api': 8.4.7(storybook@8.4.4)
'@storybook/theming': 8.4.7(storybook@8.4.4)
storybook: 8.4.4
'@storybook/manager-api': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/preview-api': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@storybook/theming': 8.4.7(storybook@8.4.4(prettier@3.4.2))
storybook: 8.4.4(prettier@3.4.2)
svelte: 5.16.0
sveltedoc-parser: 4.2.1
ts-dedent: 2.2.0
@ -14895,29 +14905,29 @@ snapshots:
transitivePeerDependencies:
- supports-color
'@storybook/test@8.4.7(storybook@8.4.4)':
'@storybook/test@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
'@storybook/csf': 0.1.11
'@storybook/global': 5.0.0
'@storybook/instrumenter': 8.4.7(storybook@8.4.4)
'@storybook/instrumenter': 8.4.7(storybook@8.4.4(prettier@3.4.2))
'@testing-library/dom': 10.4.0
'@testing-library/jest-dom': 6.5.0
'@testing-library/user-event': 14.5.2(@testing-library/dom@10.4.0)
'@vitest/expect': 2.0.5
'@vitest/spy': 2.0.5
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/theming@8.4.4(storybook@8.4.4)':
'@storybook/theming@8.4.4(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/theming@8.4.7(storybook@8.4.4)':
'@storybook/theming@8.4.7(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@storybook/types@8.4.4(storybook@8.4.4)':
'@storybook/types@8.4.4(storybook@8.4.4(prettier@3.4.2))':
dependencies:
storybook: 8.4.4
storybook: 8.4.4(prettier@3.4.2)
'@sveltejs/package@2.3.7(svelte@5.16.0)(typescript@5.6.3)':
dependencies:
@ -21976,6 +21986,8 @@ snapshots:
prelude-ls@1.2.1: {}
prettier@3.4.2: {}
pretty-error@4.0.0:
dependencies:
lodash: 4.17.21
@ -23043,14 +23055,14 @@ snapshots:
stdin-discarder@0.2.2: {}
storybook-dark-mode@4.0.2(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4):
storybook-dark-mode@4.0.2(react-dom@18.3.1(react@18.2.0))(react@18.2.0)(storybook@8.4.4(prettier@3.4.2)):
dependencies:
'@storybook/components': 8.4.4(storybook@8.4.4)
'@storybook/core-events': 8.4.4(storybook@8.4.4)
'@storybook/components': 8.4.4(storybook@8.4.4(prettier@3.4.2))
'@storybook/core-events': 8.4.4(storybook@8.4.4(prettier@3.4.2))
'@storybook/global': 5.0.0
'@storybook/icons': 1.2.12(react-dom@18.3.1(react@18.2.0))(react@18.2.0)
'@storybook/manager-api': 8.4.4(storybook@8.4.4)
'@storybook/theming': 8.4.4(storybook@8.4.4)
'@storybook/manager-api': 8.4.4(storybook@8.4.4(prettier@3.4.2))
'@storybook/theming': 8.4.4(storybook@8.4.4(prettier@3.4.2))
fast-deep-equal: 3.1.3
memoizerific: 1.11.3
transitivePeerDependencies:
@ -23058,9 +23070,11 @@ snapshots:
- react-dom
- storybook
storybook@8.4.4:
storybook@8.4.4(prettier@3.4.2):
dependencies:
'@storybook/core': 8.4.4
'@storybook/core': 8.4.4(prettier@3.4.2)
optionalDependencies:
prettier: 3.4.2
transitivePeerDependencies:
- bufferutil
- supports-color

View file

@ -1,2 +1,4 @@
.docusaurus
/api/
/build/
/node_modules/

View file

@ -6,7 +6,6 @@ tags: [podman-desktop, podman, Kubernetes-application, deployment]
hide_table_of_contents: false
---
# Using Podman Desktop to create a Kubernetes application
The integration of Podman Desktop with Kubernetes helps you to run your application on a Kubernetes cluster, such as Kind or Minikube.
@ -32,6 +31,7 @@ To do so, you can pull the relevant images from the `quay.io` registry.
2. Click **Pull**.
![pull from registry](img/building-a-kubernetes-application/pulling-from-registry.png)
3. Start the first container:
1. Enter the image name to pull from a registry. For example, `quay.io/podman-desktop-demo/podify-demo-backend`.
![enter image name](img/building-a-kubernetes-application/enter-image-name.png)
2. Click **Pull image**. A download complete notification opens.
@ -45,6 +45,7 @@ To do so, you can pull the relevant images from the `quay.io` registry.
![view Logs tab](img/building-a-kubernetes-application/redis-running-in-logs.png)
4. Start the second container:
1. Enter the image name to pull from a registry. For example, `quay.io/podman-desktop-demo/podify-demo-frontend`.
2. Click **Pull image** and then **Done**.
3. Click the `Run Image` icon corresponding to the new image added.
@ -111,7 +112,7 @@ The following procedure creates a pod that runs on a Podman engine.
9. Select the YAML file from your machine.
10. Check that the **Runtime** field is set to `Podman container engine`.
11. Click **Play** and then **Done**.
13. View the newly created pod on the same page.
12. View the newly created pod on the same page.
After creating the pod, set up a local Kubernetes cluster to deploy the pod.
@ -151,6 +152,7 @@ You can deploy the application pod to a Kubernetes cluster that has an active co
1. Go the **Kubernetes** component page.
2. Perform the following steps:
1. Click the **Services** option to view the newly created service, `my-pod-5000`.
![service created](img/building-a-kubernetes-application/service-created.png)
2. Click the **Ingresses and Routes** option to view the newly created ingress, `my-pod`.

View file

@ -9,7 +9,6 @@ hide_table_of_contents: false
image: /img/blog/podman-desktop-release-1.14/banner.png
---
import ReactPlayer from 'react-player'
Podman Desktop 1.14 Release! 🎉

View file

@ -197,19 +197,15 @@ Podman AI Lab provides a way for a user to extend the provided catalog with its
"recipes": [
{
"id": "search-podman-desktop-io",
"description" : "Search on Podman-desktop.io website",
"name" : "Search Podman-desktop.io",
"description": "Search on Podman-desktop.io website",
"name": "Search Podman-desktop.io",
"repository": "https://github.com/redhat-developer/podman-desktop-demo",
"ref": "main",
"icon": "natural-language-processing",
"categories": [
"natural-language-processing"
],
"categories": ["natural-language-processing"],
"basedir": "ai-lab-demo/recipe",
"readme": "",
"recommended": [
"hf.TheBloke.mistral-7b-instruct-v0.2.Q4_K_M"
],
"recommended": ["hf.TheBloke.mistral-7b-instruct-v0.2.Q4_K_M"],
"backend": "llama-cpp"
}
]

View file

@ -37,8 +37,8 @@ its vital to provide a convenient way to submit feedback directly to GitHub v
While retaining our internal anonymous feedback system, this update also enables users to preview their issues on GitHub, ensuring better communication.
<ThemedImage
alt="Feedback Form"
sources={{
alt="Feedback Form"
sources={{
light: require('./img/podman-desktop-release-1.15/feedback-form-light.png').default,
dark: require('./img/podman-desktop-release-1.15/feedback-form-dark.png').default,
}}
@ -53,8 +53,8 @@ We now offer three distinct feedback categories:
- **Bug**: Allows users to report bugs directly on GitHub.
<ThemedImage
alt="Feedback categories"
sources={{
alt="Feedback categories"
sources={{
light: require('./img/podman-desktop-release-1.15/feedback-categories-light.png').default,
dark: require('./img/podman-desktop-release-1.15/feedback-categories-dark.png').default,
}}
@ -69,8 +69,8 @@ Back in the [0.13 release](/blog/podman-desktop-release-0.13#new-task-manager-17
To try it out, go to `Settings > Preferences > Tasks` and enable the `Manager` option.
<ThemedImage
alt="task manager experimental preference"
sources={{
alt="task manager experimental preference"
sources={{
light: require('./img/podman-desktop-release-1.15/experimental-task-manager-preference-light.png').default,
dark: require('./img/podman-desktop-release-1.15/experimental-task-manager-preference-dark.png').default,
}}
@ -85,8 +85,8 @@ Key changes include:
- Additional capabilities for managing individual tasks.
<ThemedImage
alt="task manager experimental preference"
sources={{
alt="task manager experimental preference"
sources={{
light: require('./img/podman-desktop-release-1.15/experimental-task-manager-opened-light.png').default,
dark: require('./img/podman-desktop-release-1.15/experimental-task-manager-opened-dark.png').default,
}}
@ -99,8 +99,8 @@ version 1.15 introduces support for [Kubernetes Events](https://kubernetes.io/do
These events are now available for resources like Nodes, Services, and Pods.
<ThemedImage
alt="task manager experimental preference"
sources={{
alt="task manager experimental preference"
sources={{
light: require('./img/podman-desktop-release-1.15/kubernetes-node-events-light.png').default,
dark: require('./img/podman-desktop-release-1.15/kubernetes-node-events-dark.png').default,
}}
@ -112,8 +112,8 @@ A frequent user request has been the ability to establish an SSH connection to a
In this release, you can now directly connect to your Podman machine from its details page.
<ThemedImage
alt="task manager experimental preference"
sources={{
alt="task manager experimental preference"
sources={{
light: require('./img/podman-desktop-release-1.15/podman-machine-ssh-light.png').default,
dark: require('./img/podman-desktop-release-1.15/podman-machine-ssh-dark.png').default,
}}

View file

@ -21,9 +21,9 @@ It's an accessible platform for developers working with single-container applica
Podman Desktop brings together three powerful features for managing small to large-scale projects:
* **Container Management**: Supports creating, running, and monitoring containers.
* **Compose Support**: Allows you to deploy applications defined in [Compose files](https://www.compose-spec.io/). This is particularly useful for managing applications that require multiple services, such as web servers, databases, and caches.
* **Kubernetes Integration**: Offers tools to manage multi-node Kubernetes clusters, making it ideal for handling more complex distributed applications that need orchestration across several pods and services. You can setup your own development cluster with Podman Desktop using our [Minikube](/docs/minikube/installing-extension) or [Kind](/docs/kind/installing-extension) extensions.
- **Container Management**: Supports creating, running, and monitoring containers.
- **Compose Support**: Allows you to deploy applications defined in [Compose files](https://www.compose-spec.io/). This is particularly useful for managing applications that require multiple services, such as web servers, databases, and caches.
- **Kubernetes Integration**: Offers tools to manage multi-node Kubernetes clusters, making it ideal for handling more complex distributed applications that need orchestration across several pods and services. You can setup your own development cluster with Podman Desktop using our [Minikube](/docs/minikube/installing-extension) or [Kind](/docs/kind/installing-extension) extensions.
## Minikube

View file

@ -134,6 +134,7 @@ Before creating a Podman machine, you can use one of the following ways to enabl
**_Configuring an environment variable_**
1. Perform one of the following steps:
- As a normal user, set the following variable at session level:
```shell-session

View file

@ -12,7 +12,7 @@ import ReactPlayer from 'react-player'
:::note
Kind is a *built-in* extension to Podman Desktop and no installation is necessary.
Kind is a _built-in_ extension to Podman Desktop and no installation is necessary.
:::

View file

@ -67,6 +67,7 @@ spec:
#### Verification
1. View the created object:
- View the `Pod` object on the **Pods** component page.
- View the other Kubernetes objects on the related object page. For example, if you have created a `Node` object, you can view it on the **Kubernetes > Nodes** page.

View file

@ -38,6 +38,7 @@ spec:
#### Procedure: Start port forwarding
1. Create a Kubernetes pod:
1. Go to the **Pods** component page.
1. Click **Play Kubernetes YAML**.
![play kubernetes yaml](img/play-kubernetes-yaml.png)

View file

@ -44,10 +44,10 @@ As a developer, you can:
2. **System socket status** setting: View the socket mapping status to check whether the socket is reachable.
3. **Docker CLI Context** setting: Select a socket context to work with from the dropdown list.
4. **Podman Compose CLI Support** setting: Check whether the Podman Compose CLI is supported. If not, use the **Setup...** button to install and set up the CLI.
![Docker compatibility page on Windows](img/docker-compatibility-page-on-windows.png)
![Docker compatibility page on Windows](img/docker-compatibility-page-on-windows.png)
</TabItem>
<TabItem value="macOS" label="macOS" className="markdown">
<TabItem value="macOS" label="macOS" className="markdown">
#### Procedure
@ -56,9 +56,10 @@ As a developer, you can:
3. **Docker CLI Context** setting: Select a socket context to work with from the dropdown list.
4. **Podman Compose CLI Support** setting: Check whether the Podman Compose CLI is supported. If not, use the **Setup...** button to install and set up the CLI.
5. **Third-Party Docker Tool Compatibility** setting: Customize the setting, if needed. When enabled, you can use third-party Docker tools with Podman.
![Docker compatibility page on macOS](img/docker-compatibility-page-on-macOS.png)
![Docker compatibility page on macOS](img/docker-compatibility-page-on-macOS.png)
</TabItem>
<TabItem value="linux" label="Linux" className="markdown">
<TabItem value="linux" label="Linux" className="markdown">
#### Procedure
@ -66,7 +67,7 @@ As a developer, you can:
2. **System socket status** setting: View the socket mapping status to check whether the socket is reachable.
3. **Docker CLI Context** setting: Select a socket context to work with from the dropdown list.
4. **Podman Compose CLI Support** setting: Check whether the Podman Compose CLI is supported. If not, use the **Setup...** button to install and set up the CLI.
![Docker compatibility page on Linux](img/docker-compatibility-page-on-linux.png)
![Docker compatibility page on Linux](img/docker-compatibility-page-on-linux.png)
</TabItem>
</Tabs>

View file

@ -6,7 +6,6 @@ keywords: [podman desktop, podman, extensions, troubleshoot]
tags: [troubleshooting-extension-issues]
---
# Troubleshooting extension-related issues
## Podman Desktop failed to create a Minikube cluster

View file

@ -265,7 +265,7 @@ Error: vm podman-machine-default not found: podman-machine-default: VM does not
#### Workaround
- Prefix each `podman machine` command with
`CONTAINERS_MACHINE_PROVIDER=libkrun`. For example, `CONTAINERS_MACHINE_PROVIDER=libkrun podman machine ls`.
`CONTAINERS_MACHINE_PROVIDER=libkrun`. For example, `CONTAINERS_MACHINE_PROVIDER=libkrun podman machine ls`.
- Manually configure the `containers.conf` file or the `CONTAINERS_MACHINE_PROVIDER` environment variable. See [Using `libkrun` as machine provider](/docs/installation/macos-install#using-libkrun-as-machine-provider).
#### Additional resources

View file

@ -13,8 +13,8 @@
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc",
"format:check": "biome format",
"format:fix": "biome format --write",
"format:check": "biome format && prettier --cache --check '**/*.md'",
"format:fix": "biome format --write && prettier --cache --write --check '**/*.md'",
"markdownlint:check": "markdownlint-cli2 --config ../.markdownlint.yaml \"**/*.md\" \"#node_modules\" \"#api\" ",
"markdownlint:fix": "markdownlint-cli2 --fix --config ../.markdownlint.yaml \"**/*.md\" \"#node_modules\"",
"vale": "vale sync && vale --config ../.vale.ini .",