Skip to content

Commit

Permalink
docs(readme-output): add docs for readme diagram color configs
Browse files Browse the repository at this point in the history
  • Loading branch information
tanner-reits committed Sep 17, 2024
1 parent bff3e6d commit 697736b
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/documentation-generation/docs-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -563,3 +563,28 @@ When strict mode is enabled, the following items are checked:
2. `@Method()` usages must be documented, unless the method is marked as `@deprecated`
3. `@Event()` usages must be documented, unless the event is marked as `@deprecated`
4. CSS Part usages must be documented

### Diagram Colors

**Optional**

**Default: `{ text: '#333', background: '#f9f' }`**

This option allows you to change the colors used when generating the dependency graph mermaid diagrams for components. Any hex color string is a valid
value.

```tsx title="stencil.config.ts"
import { Config } from '@stencil/core';

export const config: Config = {
outputTargets: [
{
type: 'docs-readme',
colors: {
text: '#fff',
background: '#000'
}
}
]
};
```

0 comments on commit 697736b

Please sign in to comment.