linkeR/_pkgdown.yml at main · EpiForeSITE/linkeR · 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
url: https://EpiForeSITE.github.io/linkeR/
template:
  bootstrap: 5
  bslib:
    primary: "#0054AD"
    border-radius: 0.5rem
    btn-border-radius: 0.25rem

home:
  title: "linkeR - Link Interactive Plots and Tables"
  description: >
    A simple interface to create bidirectional links between interactive
    plots and tables in 'shiny' applications.

navbar:
  structure:
    left: [intro, reference, articles, tutorials, news]
    right: [search, github]

reference:
- title: "Main Function"
  desc: "The easiest way to link components"
  contents:
  - link_plots

- title: "Advanced Usage & Component API"
  desc: >
    For advanced use cases or integrating custom components. Most users
    should start with `link_plots()`.
  contents:
  - create_link_registry
  - register_leaflet
  - register_dt
  - register_plotly
  - prepare_plotly_linking
  - diagnose_registry

- title: "Internal Functions"
  desc: "Internal functions for advanced users"
  contents:
  - setup_component_observers
  - setup_leaflet_observers
  - setup_datatable_observers
  - update_leaflet_selection
  - update_dt_selection
  - apply_default_leaflet_behavior

# Exclude imports from documentation
- title: internal
  contents:
  - linkeR-imports

articles:
- title: "Getting Started"
  navbar: ~
  contents:
  - getting-started

- title: "Using with 'shiny' Modules"
  navbar: ~
  contents:
  - using-with-modules

- title: "Advanced Usage"
  navbar: ~
  contents:
  - multiple-components

- title: "Custom Behaviors"
  navbar: ~
  contents:
  - custom-behaviors

- title: "sf Integration"
  navbar: ~
  contents:
  - sf-integration

- title: "Using plotly"
  navbar: ~
  contents:
  - using-plotly