Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2024-10-01 01:36:09 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docusaurus and enable broken anchor detection

Browse Source
This commit is contained in:
Thomas Tendyck 2024-08-23 13:03:38 +02:00 committed by Thomas Tendyck
parent ded559a3fe
commit e90b0e5109
5 changed files with 27 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/docusaurus.config.js
View File

@ -13,6 +13,7 @@ async function createConfig() {
baseUrl: '/constellation/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
onBrokenAnchors: 'throw',
favicon: 'img/favicon.ico',
// GitHub pages deployment config.

33
docs/package.json
View File

@ -14,18 +14,27 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@cmfcmf/docusaurus-search-local": "^1.1.0",
"@docusaurus/core": "^2.2.0",
"@docusaurus/module-type-aliases": "^2.2.0",
"@docusaurus/plugin-google-gtag": "^2.4.1",
"@docusaurus/preset-classic": "^2.4.1",
"@docusaurus/theme-mermaid": "^2.4.1",
"@mdx-js/react": "^1.6.22",
"asciinema-player": "^3.5.0",
"clsx": "^1.2.1",
"prism-react-renderer": "^2.0.6",
"react": "^17.0.2",
"react-dom": "^17.0.2"
"@cmfcmf/docusaurus-search-local": "^1.2.0",
"@docusaurus/core": "^3.5.2",
"@docusaurus/plugin-google-gtag": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@docusaurus/theme-mermaid": "^3.5.2",
"@mdx-js/react": "^3.0.0",
"asciinema-player": "^3.8.0",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/types": "^3.5.2"
},
"overrides": {
"@cmfcmf/docusaurus-search-local": {
"@docusaurus/core": "3.5.2",
"cheerio": "1.0.0-rc.12"
}
},
"browserslist": {
"production": [

6
docs/src/theme/MDXComponents.js
View File

@ -10,7 +10,7 @@ export default {
...MDXComponents,
// Map the "highlight" tag to our <Highlight /> component!
// `Highlight` will receive all props that were passed to `highlight` in MDX
tabs: Tabs,
tabItem: TabItem,
asciinemaWidget: AsciinemaWidget,
Tabs,
TabItem,
AsciinemaWidget,
};

2
docs/versioned_docs/version-2.0/workflows/create.md
View File

@ -53,7 +53,7 @@ constellation create --control-plane-nodes 1 --worker-nodes 2
For details on the flags, consult the command help via `constellation create -h`.
*create* stores your cluster's configuration to a file named [`constellation-state.json`](../architecture/orchestration.md#installation-process) in your current directory.
*create* stores your cluster's configuration to a file named [`constellation-state.json`](../architecture/orchestration.md#cluster-creation-process) in your current directory.
## The *init* step

2
docs/versioned_docs/version-2.1/workflows/create.md
View File

@ -57,7 +57,7 @@ constellation create --control-plane-nodes 1 --worker-nodes 2
For details on the flags, consult the command help via `constellation create -h`.
*create* stores your cluster's configuration to a file named [`constellation-state.json`](../architecture/orchestration.md#installation-process) in your current directory.
*create* stores your cluster's configuration to a file named [`constellation-state.json`](../architecture/orchestration.md#cluster-creation-process) in your current directory.
## The *init* step