ggplotly/mkdocs.yml at main · bbcho/ggplotly · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
site_name: ggplotly
site_description: A grammar of graphics for Python with Plotly interactivity
site_url: https://bbcho.github.io/ggplotly
repo_url: https://github.com/bbcho/ggplotly
repo_name: bbcho/ggplotly

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.highlight
    - search.suggest

plugins:
  - search
  - mkdocs-jupyter:
      execute: true
      ignore_h1_titles: true
      include_source: true
      include_requirejs: true
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_source: false
            show_root_heading: true
            heading_level: 2

nav:
  - Home: index.ipynb
  - Getting Started: getting-started.ipynb
  - User Guide:
    - Aesthetics: guide/aesthetics.ipynb
    - Geoms: guide/geoms.ipynb
    - Scales: guide/scales.ipynb
    - Themes: guide/themes.ipynb
    - Facets: guide/facets.ipynb
    - Coordinates: guide/coordinates.ipynb
    - Labels & Annotations: guide/labels.ipynb
  - Gallery:
    - Overview: gallery/index.md
    - Basic Charts: gallery/basic.ipynb
    - Statistical: gallery/statistical.ipynb
    - Time Series: gallery/timeseries.ipynb
    - Geographic Maps: gallery/maps.ipynb
    - 3D Visualizations: gallery/3d.ipynb
    - Network Graphs: gallery/networks.ipynb
    - Facets: gallery/facets.ipynb
    - Theming: gallery/theming.ipynb
  - API Reference:
    - ggplot: api/ggplot.md
    - Geoms: api/geoms.md
    - Scales: api/scales.md
    - Themes: api/themes.md
    - Stats: api/stats.md
    - Guides: api/guides.md
    - Facets: api/facets.md
    - Coordinates: api/coords.md
    - Positions: api/positions.md
    - Datasets: api/datasets.md
    - Utilities: api/utils.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bbcho/ggplotly
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ggplotly/