docs-cds-rdm/mkdocs.yml at main · CERNDocumentServer/docs-cds-rdm · 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
115
116
117
118
119
120
121
122
123
124
125
126
site_name: Documentation
site_url: https://repository.cern/docs/
site_description: Documentation for CERN Document Server (CDS)
site_author: CERN

# Repository
repo_url: ""

# Copyright
copyright: Copyright &copy; CERN 2025

# Theme configuration
theme:
  name: material
  language: en

  # Color palette
  palette:
    scheme: default
    primary: custom
    accent: blue

  # Font configuration
  font:
    text: Roboto
    code: Roboto Mono
  logo: images/cds.svg
  favicon: images/favicon.ico

  # Features
  features:
    - navigation.sections # Section index pages
    - navigation.expand # Expand subsections
    - navigation.top # Back to top button
    - navigation.footer # Previous/next in footer
    - navigation.instant # Instant loading
    - navigation.tracking # Anchor tracking

    # Search
    - search.suggest # Search suggestions
    - search.highlight # Highlight search terms
    - search.share # Share search results

    # Table of Contents
    - toc.follow # TOC follows scroll

    # Content
    - content.code.copy # Copy code button
    - content.code.annotate # Code annotations
    - content.tabs.link # Link content tabs
    - content.tooltips # Improved tooltips
    - content.action.edit # Edit button

  # # Icon overrides
  # icon:
  #   repo: fontawesome/brands/github
  #   edit: material/pencil
  #   view: material/eye
  #   logo: material/database
  #   admonition:
  #     note: octicons/tag-16
  #     abstract: octicons/checklist-16
  #     info: octicons/info-16
  #     tip: octicons/light-bulb-16
  #     success: octicons/check-16
  #     question: octicons/question-16
  #     warning: octicons/alert-16
  #     failure: octicons/x-circle-16
  #     danger: octicons/zap-16
  #     bug: octicons/bug-16
  #     example: octicons/beaker-16
  #     quote: octicons/quote-16

# Plugins
plugins:
  - glightbox
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - pymdownx.details
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      permalink_title: Link to this section
      toc_depth: 3

# Additional CSS and JavaScript
extra_css:
  - stylesheets/extra.css

# Extra configuration
extra:
  homepage: https://repository.cern
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cerndocumentserver/cds-rdm
      name: CDS-RDM on GitHub

# Navigation structure
nav:
  - Home: index.md
  - Deposit:
      - Upload: deposit/upload.md
      - Published records: deposit/published-records.md
      - Access & Share: deposit/access-share.md
  - Search:
      - How to search: search/search.md
  - Communities:
      - About communities: communities/communities.md
      - Manage communities: communities/manage.md
      - Submit to a community: communities/submit.md
  - Reviews:
      - About reviews: review/review.md
      - Commenting: review/comments.md
  - Reference: reference/reference.md
  - Glossary: glossary.md
  - FAQ: faq.md