elasticstack/mkdocs.yml at main · Oddly/elasticstack · 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
113
114
site_name: oddly.elasticstack
site_description: Deploy and manage the Elastic Stack with Ansible
site_url: https://oddly.github.io/elasticstack/
repo_url: https://github.com/Oddly/elasticstack
repo_name: Oddly/elasticstack
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/elastic-logo.svg
  favicon: assets/elastic-logo.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.highlight
    - search.suggest
    - toc.follow
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Oddly/elasticstack
      name: elasticstack on GitHub

extra_css:
  - stylesheets/custom.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      baselevel: 1
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

exclude_docs: |
  wiki/

nav:
  - Home: index.md
  - Introduction:
      - introduction/index.md
      - Getting Started: introduction/getting-started.md
  - Guide:
      - guide/index.md
      - Architecture: guide/architecture.md
      - Security: guide/security.md
      - TLS & Certificates: guide/tls.md
      - Upgrading: guide/upgrades.md
      - Performance Tuning: guide/performance.md
      - Best Practices: guide/best-practices.md
  - Reference:
      - reference/index.md
      - Shared Defaults: reference/elasticstack.md
      - Repository Setup: reference/repos.md
      - Elasticsearch: reference/elasticsearch.md
      - Kibana: reference/kibana.md
      - Logstash: reference/logstash.md
      - Beats: reference/beats.md
  - "How To":
      - how-to/index.md
      - Deployment: how-to/deployment.md
      - Cluster Operations: how-to/cluster-operations.md
      - Configuration: how-to/configuration.md
      - Pipelines & Inputs: how-to/pipelines.md
      - Scaling & HA: how-to/scaling.md
      - Monitoring: how-to/monitoring.md
  - FAQ: faq.md