docs/mkdocs.yml at main · DependencyTrack/docs · 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
# This file is part of Dependency-Track.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
site_name: "Dependency-Track"
site_url: https://dependencytrack.github.io/docs/
repo_url: https://github.com/DependencyTrack/dependency-track
repo_name: DependencyTrack/dependency-track
docs_dir: docs
copyright: "Copyright &copy; OWASP Foundation. All Rights Reserved."

theme:
  name: material
  logo: assets/images/logo.svg
  favicon: assets/images/logo.svg
  palette:
  - scheme: slate
    primary: custom
    accent: custom
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  - scheme: default
    primary: custom
    accent: custom
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  features:
  - content.code.copy
  - content.tabs.link
  - navigation.footer
  - navigation.indexes
  - navigation.instant
  - navigation.path
  - navigation.prune
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.highlight
  - toc.follow

extra:
  version:
    provider: mike
    default: latest
  social:
  - icon: fontawesome/brands/slack
    link: https://dependencytrack.org/slack
  - icon: fontawesome/brands/github
    link: https://github.com/DependencyTrack
  - icon: fontawesome/brands/docker
    link: https://hub.docker.com/u/dependencytrack
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/company/owasp-dependency-track
  - icon: fontawesome/brands/mastodon
    link: https://infosec.exchange/@DependencyTrack

extra_css:
- stylesheets/extra.css

markdown_extensions:
- abbr
- admonition
- attr_list
- md_in_html
- toc:
    permalink: true
- pymdownx.details
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.snippets:
    auto_append:
    - docs/includes/abbreviations.md
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
    alternate_style: true

plugins:
- search
- social
- awesome-pages
- glightbox
- blog:
    categories_allowed:
    - Release
    - Engineering
    - Community
- rss:
    match_path: blog/posts/.*
    date_from_meta:
      as_creation: date
    categories:
    - categories
    - tags
- swagger-ui-tag:
    filter: true
    supportedSubmitMethods: []