plotit/_pkgdown.yml at main · zorrooz/plotit · 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
102
103
104
105
106
107
108
109
110
111
112
url: https://zorrooz.github.io/plotit/
template:
  bootstrap: 5
  includes:
    in_header: |
      <style>.r-plt { display: block; margin: 1rem 0; }
      .r-plt img { display: block; max-width: 100%; height: auto; margin: 0 auto; background: #fff; border-radius: 4px; box-shadow: 0 1px 3px rgba(0,0,0,.1); }</style>

# Reference-example figure canvas. WYSIWYG default panel is Nature
# single-column 89 x 56 mm (~3.5 x 2.2 in); device fits panel + chrome
# without a large margin. ragg background=white paints PNGs opaque.
figures:
  dev: ragg::agg_png
  dpi: 96
  fig.retina: 2
  fig.width: 5.2
  fig.height: 4.0
  dev.args:
    bg: white

title: plotit
subtitle: Declarative Plotting with ggplot2

development:
  mode: release

# Documentation IA (see AGENTS.md §4.9, DESIGN.md):
# tidyverse-style navbar: Get Started first, then Reference, then the
# remaining articles under Articles. Five articles only.
navbar:
  structure:
    left:  [intro, reference, articles, news]
    right: [search, github]
  components:
    intro:
      text: Get Started
      href: articles/plotit.html
    articles:
      text: Articles
      menu:
      - text: Gallery
        href: articles/visualizing-data.html
      - text: Advanced
        href: articles/advanced.html
      - text: API
        href: articles/api.html
      - text: "---"
      - text: Design Goals
        href: articles/design-goals.html
    news:
      text: News
      href: news/index.html
    github:
      icon: fab fa-github
      href: https://github.com/zorrooz/plotit
      aria-label: GitHub repository

reference:
- title: Plot Construction
  contents:
  - plotit
  - encode
  - add_ggplot
- title: Geometric Layers
  desc: Add visual marks to your plot.
  contents:
  - starts_with("mark_")
- title: Scales
  desc: Control how data maps to visual properties.
  contents:
  - starts_with("scale_")
- title: Graph Data & Layout
  desc: Build relational graphs and compute layouts (Vega-style data transforms).
  contents:
  - as_graph
  - starts_with("layout_")
- title: Labels
  desc: Set titles, axis labels, and legend text.
  contents:
  - starts_with("label_")
- title: Coordinate Systems
  desc: Transform the coordinate space.
  contents:
  - starts_with("project_")
- title: Facets
  desc: Split data into subplots.
  contents:
  - starts_with("split_")
- title: Composition
  desc: Combine multiple plots into layouts.
  contents:
  - starts_with("compose_")
- title: Theme
  desc: Style your plots with built-in or custom themes.
  contents:
  - style
- title: Export
  desc: Render and save your plots to files.
  contents:
  - export
- title: Customization
  desc: Extend plotit with custom marks and themes.
  contents:
  - make_mark
  - make_theme

# Exclude from search, sitemap, and navbar.
# pkgdown's build_home() always renders root .md files; CI workflow
# removes AGENTS.html post-build — see .github/workflows/pkgdown.yaml.
exclude:
- AGENTS.md
- DESIGN.md