Skip to content

Commit

Permalink
doc: fix mermaid diagrams for component documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Birrer, Iwan authored and ibirrer committed Oct 4, 2024
1 parent 53ef311 commit b9edd84
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { defineConfig } from 'vitepress';
import { components } from '../components/component.tags.mjs';
import { withMermaid } from 'vitepress-plugin-mermaid';

const componentNavItems = components.map((component) => {
return {
Expand All @@ -13,7 +13,7 @@ const componentNavItems = components.map((component) => {
});

// https://vitepress.dev/reference/site-config
export default defineConfig({
export default withMermaid({
ignoreDeadLinks: [/^https?:\/\/localhost/, './../wrappers/set-attributes'],
appearance: false,
head: [['link', { rel: 'icon', href: 'favicon.ico' }]],
Expand Down
24 changes: 12 additions & 12 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Upcoming

### Added
### Removed

### Fixed
- **Breaking**: Temporarily removed React support to unblock dependency updates.

React no longer works with the latest Stencil output target, which is preventing us from updating
our dependencies to their latest versions. Since the team currently lacks the resources to fix
this issue, we're removing React support temporarily to prevent it from hindering progress.

### Changed

- Updated dependencies and cleaned up test config.

### Fixed

- Fixed mermaid diagrams in component documentation.

## 4.2.6 - 2024-10-04

### Fixed
Expand All @@ -21,16 +31,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
- `six-select`: fix multiple checkmark bug for single select mode
- `six-input`: fix disabled input being clearable

### Changed

- **Breaking**: Temporarily remove React support to unblock dependency updates.

React no longer works with the latest Stencil output target, which is preventing us from updating
our dependencies to their latest versions. Since the team currently lacks the resources to fix
this issue, we're removing React support temporarily to prevent it from hindering progress.

- Updated dependencies and cleand up test config for Stencil.

## 4.2.5 - 2024-09-12

### Added
Expand Down
2 changes: 2 additions & 0 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@
},
"devDependencies": {
"cpy-cli": "^5.0.0",
"mermaid": "^11.2.1",
"node-html-parser": "^6.1.5",
"rimraf": "^5.0.1",
"turndown": "^7.1.2",
"vitepress": "^1.2.3",
"vitepress-plugin-mermaid": "^2.0.17",
"vue": "^3.4.21"
},
"scripts": {
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b9edd84

Please sign in to comment.