Skip to content

Commit

Permalink
document how to set options, see #19
Browse files Browse the repository at this point in the history
  • Loading branch information
timvink authored Sep 25, 2023
1 parent 7abd2f0 commit 87789f5
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/options.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Options

You can customize the plugin by setting options in `mkdocs.yml`. For example:

=== ":octicons-file-code-16: mkdocs.yml"

```yaml
plugins:
- charts:
vega_width: container
vega_theme: default
vega_theme_dark: dark
vega_renderer: svg
use_data_path: True
data_path: ""
```
- `vega_width` (default is `container`). When not specified explicitly in the JSON schema, the `width` to use (see [vegalite customizing size](https://vega.github.io/vega-lite/docs/size.html)). When set to `container` width will be 100%.
- `vega_theme` (default is `default`). Specify one of the available [vegalite themes](https://vega.github.io/vega-themes/).
- `vega_theme_dark` (default is `dark`). When using the [mkdocs-material](https://squidfunk.github.io/mkdocs-material) theme with a dark mode, automatically render charts using this theme. Dark mode toggle is also supported. Specify one of the available [vegalite themes](https://vega.github.io/vega-themes/).
Expand Down

0 comments on commit 87789f5

Please sign in to comment.