pglinter/mkdocs.yml at main · pmpetit/pglinter · 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
site_name: pglinter
site_description: PostgreSQL Database Linting and Analysis Extension
site_author: pglinter contributors
copyright: Copyright 2024-2025 pglinter contributors
repo_url: https://github.com/pmpetit/pglinter
edit_uri: edit/main/docs/

theme:
  name: readthedocs
  highlightjs: true
  hljs_languages:
    - yaml
    - sql
    - bash
    - rust

nav:
  - 'Home': index.md
  - 'Configuration': configure.md
  - 'Security': SECURITY.md
  - Install:
      - 'Installation': install.md
  - How-To Guides:
    - 'Overview': how-to/README.md
  - Functions Reference:
    - 'Functions': functions/README.md
    - 'Get Violations': functions/get_violations.md
  - Rules Reference:
    - 'Rules': rules/README.md
  - Tutorial:
    - 'Create rules': tutorial/how_to_create_rules.md
  - Examples:
    - 'Examples': examples/README.md

# Markdown settings
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  - tables
  - fenced_code

# Additional settings
use_directory_urls: true
strict: false

# Plugin settings
plugins:
  - search

# Extra settings for ReadTheDocs
extra:
  version:
    provider: mike