compliance-trestle/mkdocs.yml at develop · oscal-compass/compliance-trestle · 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
edit_uri: ''
extra:
  version:
    provider: mike
  analytics:
    property: G-XT3KGMHSY8
    provider: google
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.
markdown_extensions:
- admonition
- markdown_include.include
- md_in_html
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.snippets
- toc:
    permalink: ¤
plugins:
- awesome-pages
# warning don't use `macros` - yet
- search
- social
- autorefs
- git-revision-date-localized
- htmlproofer:
    enabled: true
    validate_rendered_template: false
    validate_external_urls: true
    # Fail on errors except for 429 (rate limiting) and transient 5xx server errors
    raise_error_after_finish: true
    raise_error_excludes:
      # This is to remove some false positives for links which work.
      # Anchors are validated again by core mkdocs
      404: [ '*#trestle.*' ]
      # Don't fail on 429 (Too Many Requests) - rate limiting is expected
      429: [ '*' ]
      # Ignore transient server-side 5xx errors - the URLs are correct but the
      # remote server may be temporarily unavailable.
      # 500 Internal Server Error  - catch-all server fault, often transient
      500: [ '*' ]
      # 502 Bad Gateway           - upstream proxy/load-balancer fault
      502: [ '*' ]
      # 503 Service Unavailable   - server overloaded or in maintenance
      503: [ '*' ]
      # 504 Gateway Timeout       - also returned by the plugin for request timeouts
      504: [ '*' ]
    # Add URLs here that should be completely ignored by htmlproofer:
    ignore_urls:
        - 'https://example.com/placeholder'
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          show_inheritance_diagram: true
          inherited_members: false
          group_by_category: true
          show_category_heading: true
          show_if_no_docstring: true
          show_root_heading: true
          filters:
          - '!^_[^_]'
          - '!^__json'
          - '!^__config__'
          new_path_syntax: true
- minify:
    minify_html: true
    minify_js: false
    minify_css: true
    css_files:
    - css/mkdocstrings.css
    htmlmin_opts:
      remove_comments: true
- mike:
    # These fields are all optional; the defaults are as below...
    alias_type: symlink
    redirect_template: null
    deploy_prefix: ''
    canonical_version: latest
    version_selector: true
    css_dir: css
    javascript_dir: js
repo_name: oscal-compass/compliance-trestle
repo_url: https://github.com/oscal-compass/compliance-trestle
site_description: Documentation for compliance-trestle package.
site_name: Compliance Trestle
site_url: https://oscal-compass.github.io/compliance-trestle
theme:
  features:
  - content.code.annotate
  - navigation.tabs
  name: material
  palette:
    accent: purple
    primary: black
    scheme: slate
  time_format: "%Y-%m-%d %H:%M:%S" # The format used to display the time
  meta_time_format: "%Y-%m-%d %H:%M:%S"
  #logo: "../images/compliance-trestle-800x800-transparent.png" # Update when have a single color svg
  favicon: assets/favicon.ico
validation:
  omitted_files: warn
  absolute_links: warn # Or 'relative_to_docs' - new in MkDocs 1.6
  unrecognized_links: warn
  anchors: warn # New in MkDocs 1.6