postgres-language-server/mkdocs.yml at main · supabase-community/postgres-language-server · 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
site_name: Postgres Language Server
site_url: https://pg-language-server.com
site_description: A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.

repo_name: supabase-community/postgres-language-server
repo_url: https://github.com/supabase-community/postgres-language-server

theme:
  name: material
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
  icon:
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: lucide/sun
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: lucide/moon
        name: Switch to light mode

extra:
  version:
    provider: mike

nav:
  - Getting Started: getting_started.md
  - Manual Installation: manual_installation.md
  - Configuration: configuration.md
  - Features:
      - Syntax Diagnostics: features/syntax_diagnostics.md
      - Linting: features/linting.md
      - Database Linting: features/database_linting.md
      - Type Checking: features/type_checking.md
      - Formatting: features/formatting.md
      - PL/pgSQL Support: features/plpgsql.md
      - Autocompletion & Hover: features/editor_features.md
  - Guides:
      - Use in your IDE: guides/ide_setup.md
      - Checking Migrations: guides/checking_migrations.md
      - Configure database connection: guides/configure_database.md
      - Suppressions: guides/suppressions.md
      - Integrate with VCS: guides/vcs_integration.md
      - Continuous Integration: guides/continuous_integration.md
      - Upgrading to 0.27: guides/upgrading_to_0_27.md
  - Reference:
      - CLI Commands: reference/cli.md
      - Linter Rules: reference/rules.md
      - Linter Rule Sources: reference/rule_sources.md
      - Database Linter Rules: reference/database_rules.md
      - Database Linter Rule Sources: reference/database_rule_sources.md
      - Related Work: reference/related_work.md
      - Environment Variables: reference/env_variables.md

plugins:
  - search
  - mike
  # The docs generator lives in docs/codegen.
  - exclude:
      glob:
        - codegen/**
  - redirects:
      # Database rule pages moved out of the linter rules folder in 0.27.
      redirect_maps:
        reference/rules/auth-rls-initplan.md: reference/database-rules/auth-rls-initplan.md
        reference/rules/auth-users-exposed.md: reference/database-rules/auth-users-exposed.md
        reference/rules/duplicate-index.md: reference/database-rules/duplicate-index.md
        reference/rules/extension-in-public.md: reference/database-rules/extension-in-public.md
        reference/rules/extension-versions-outdated.md: reference/database-rules/extension-versions-outdated.md
        reference/rules/fkey-to-auth-unique.md: reference/database-rules/fkey-to-auth-unique.md
        reference/rules/foreign-table-in-api.md: reference/database-rules/foreign-table-in-api.md
        reference/rules/function-search-path-mutable.md: reference/database-rules/function-search-path-mutable.md
        reference/rules/insecure-queue-exposed-in-api.md: reference/database-rules/insecure-queue-exposed-in-api.md
        reference/rules/materialized-view-in-api.md: reference/database-rules/materialized-view-in-api.md
        reference/rules/multiple-permissive-policies.md: reference/database-rules/multiple-permissive-policies.md
        reference/rules/no-primary-key.md: reference/database-rules/no-primary-key.md
        reference/rules/policy-exists-rls-disabled.md: reference/database-rules/policy-exists-rls-disabled.md
        reference/rules/rls-disabled-in-public.md: reference/database-rules/rls-disabled-in-public.md
        reference/rules/rls-enabled-no-policy.md: reference/database-rules/rls-enabled-no-policy.md
        reference/rules/rls-policy-always-true.md: reference/database-rules/rls-policy-always-true.md
        reference/rules/rls-references-user-metadata.md: reference/database-rules/rls-references-user-metadata.md
        reference/rules/security-definer-view.md: reference/database-rules/security-definer-view.md
        reference/rules/sensitive-columns-exposed.md: reference/database-rules/sensitive-columns-exposed.md
        reference/rules/table-bloat.md: reference/database-rules/table-bloat.md
        reference/rules/unindexed-foreign-keys.md: reference/database-rules/unindexed-foreign-keys.md
        reference/rules/unsupported-reg-types.md: reference/database-rules/unsupported-reg-types.md
        reference/rules/unused-index.md: reference/database-rules/unused-index.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true