doc-cvmfs/mkdocs.yml at latest · cvmfs/doc-cvmfs · 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
site_name: CernVM-FS Documentation
site_description: CernVM-FS provides a scalable, reliable and low-maintenance software distribution service
site_author: CernVM Team
site_url: https://cvmfs.docs.cern.ch/

# Repository
repo_name: cvmfs/doc-cvmfs
repo_url: https://github.com/cvmfs/doc-cvmfs
edit_uri: edit/master/

# Configuration
theme:
  name: readthedocs
  highlightjs: false
  logo: _static/cvmfs-logo.png

# Plugins
# `mike deploy ...` / `mike serve` inject the mike plugin automatically, which
# adds the version selector for supported themes like `readthedocs` while
# keeping plain `mkdocs build --strict` usable for local and CI sanity checks.
plugins:
  - search
  - mermaid2:
      version: 9.4.3
      arguments:
        startOnLoad: true

# Extensions
markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - def_list
  - attr_list
  - tables
  - fenced_code
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      use_pygments: true
      default_lang: bash
  - pymdownx.superfences
  - pymdownx.inlinehilite
#  - codehilite:
#      guess_lang: false
#  - pymdownx.superfences:
#      custom_fences:
#        - name: mermaid
#          class: mermaid
#          format: !!python/name:pymdownx.superfences.fence_code_format

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - Overview: cpt-overview.md
    - Quick Start: cpt-quickstart.md
    - Configuration: cpt-configure.md
    - Squid Proxy: cpt-squid.md
    - Release Notes: cpt-releasenotes.md
  - Repository Management:
    - Repository Creation: cpt-repo.md
    - Server Meta-information: cpt-servermeta.md
    - Replica Servers: cpt-replica.md
    - Repository Gateway: cpt-repository-gateway.md
    - Containers: cpt-containers.md
  - Advanced Topics:
    - HPC: cpt-hpc.md
    - Shrinkwrap: cpt-shrinkwrap.md
    - Plugins: cpt-plugins.md
    - Telemetry: cpt-telemetry.md
    - Tracer: cpt-tracer.md
    - Graph Driver: cpt-graphdriver.md
    - DUCC: cpt-ducc.md
    - Details: cpt-details.md
  - Experimental:
    - Enter: cpt-enter.md
    - Notification System: cpt-notification-system.md
    - XCache: cpt-xcache.md
    - Large Scale: cpt-large-scale.md
  - Appendix:
    - Security: apx-security.md
    - Parameters: apx-parameters.md
    - Server Infrastructure: apx-serverinfra.md
    - RPM Packages: apx-rpms.md
    - Issues: apx-issues.md
    - Contact: apx-contact.md
    - References: apx-references.md

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cvmfs/cvmfs
    - icon: fontawesome/solid/globe
      link: https://cernvm.cern.ch/

extra_css:
  - _static/css/custom.css

extra_javascript:
  - _static/js/mike-logo-fix.js
  - _static/js/parameter-permalinks.js
  - _static/js/code-block-enhancements.js

# Copyright
copyright: Copyright &copy; 2025 CernVM Team