Skip to content

Commit

Permalink
Update docs.md with more clear node_color info
Browse files Browse the repository at this point in the history
  • Loading branch information
alison985 authored Sep 23, 2023
1 parent d8a207a commit ce83c67
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions website/docs/reference/resource-configs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ models:
- name: model_name
docs:
show: true | false
node_color: "black"

```

Expand Down Expand Up @@ -119,7 +120,7 @@ macros:
</Tabs>

## Definition
The docs field can be used to provide documentation-specific configuration to models. The only currently supported docs attribute is shown, which controls whether or not models are shown in the auto-generated documentation website.
The docs field can be used to provide documentation-specific configuration to models. It supports the doc attribute `show`, which controls whether or not models are shown in the auto-generated documentation website. It also supports `node_color` for some node types.

**Note:** hidden models will still appear in the dbt DAG visualization but will be identified as "hidden.”

Expand Down Expand Up @@ -173,7 +174,7 @@ models:
## Custom node colors
The `docs` attribute now supports `node_color` to customize the node color in the DAG within dbt docs. You can define node colors in the files below and apply overrides where needed.
The `docs` attribute now supports `node_color` to customize the display color of some node types in the DAG within dbt docs. You can define node colors in the files below and apply overrides where needed.

`node_color` hiearchy:

Expand All @@ -182,7 +183,7 @@ The `docs` attribute now supports `node_color` to customize the node color in th

## Examples

Add custom node colors to models within subdirectories based on hex codes or a plain color name.
Add custom `node_colors` to models that support it within subdirectories based on hex codes or a plain color name.

![Example](../../../../website/static/img/node_color_example.png)

Expand Down

0 comments on commit ce83c67

Please sign in to comment.