bgpipe/mkdocs.yml at main · bgpfix/bgpipe · 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
nav:
  - Home: index.md
  - Introduction: intro.md
  - Quick Start: quickstart.md
  - Examples: examples.md
  - Stages:
    - Overview: stages/index.md
    - aspa: stages/aspa.md
    - connect: stages/connect.md
    - drop: stages/grep.md
    - exec: stages/exec.md
    - grep: stages/grep.md
    - head: stages/head.md
    - limit: stages/limit.md
    - listen: stages/listen.md
    - metrics: stages/metrics.md
    - pipe: stages/pipe.md
    - read: stages/read.md
    - ris-live: stages/ris-live.md
    - rov: stages/rov.md
    - rv-live: stages/rv-live.md
    - speaker: stages/speaker.md
    - stdin: stages/stdin.md
    - stdout: stages/stdout.md
    - tag: stages/tag.md
    - update: stages/update.md
    - websocket: stages/websocket.md
    - write: stages/write.md
  - JSON:
    - Message format: json-format.md
    - Flowspec: flowspec.md
  - Filtering: filters.md
  - Docker: docker.md

site_name: "bgpipe: BGP pipeline processor"
site_description: "bgpipe: open-source BGP reverse proxy, firewall, and pipeline processor with RPKI validation, JSON translation, and composable stages"
site_url: 'https://bgpipe.org/'
repo_url: https://github.com/bgpfix/bgpipe

theme:
  name: material
  favicon: img/favicon.png
  logo: img/logo-w.png
  features:
    - header.autohide
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.top
    - search.highlight
    - search.suggest
  palette:
    - scheme: slate
      primary: purple
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Light mode
    - scheme: default
      primary: purple
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Dark mode

extra:
  generator: false
  version:
    provider: mike
    alias: true

extra_css:
  - css/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - toc:
      permalink: true