-
Notifications
You must be signed in to change notification settings - Fork 421
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(config): add
docs
config page/option to root config (#1485)
- Loading branch information
1 parent
bff3e6d
commit 4d995e8
Showing
2 changed files
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: Documentation Generation Config | ||
sidebar_label: Docs Config | ||
description: Documentation Generation Config | ||
slug: /docs-config | ||
--- | ||
|
||
# Docs Config | ||
|
||
The `docs` config option allows global configuration of certain behaviors related to [documentation generation output targets](../documentation-generation/01-overview.md). | ||
|
||
:::note | ||
These configurations are **global** and will be applied to all output target instances including those defined in the [`outputTargets`](../output-targets/01-overview.md) | ||
configuration, as well as those injected by CLI flags (like `--docs`). | ||
::: | ||
|
||
## markdown | ||
|
||
The `markdown` config object allows certain customizations for markdown files generated by the [`docs-readme` output target](../documentation-generation/docs-readme.md) or the | ||
`--docs` CLI flag. | ||
|
||
### targetComponent | ||
|
||
**Optional** | ||
|
||
**Default: `{ textColor: '#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 = { | ||
docs: { | ||
markdown: { | ||
targetComponent: { | ||
textColor: '#fff', | ||
background: '#000', | ||
}, | ||
}, | ||
}, | ||
}; | ||
``` |