Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme-output): add docs for readme diagram color configs #1483

Closed
wants to merge 1 commit into from
Closed

docs(readme-output): add docs for readme diagram color configs #1483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions docs/documentation-generation/docs-readme.md
View file
Open in desktop
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'
}
}
]
};
```