pgcolumnar/mkdocs.yml at main · commandprompt/pgcolumnar · 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
site_name: pgColumnar
site_description: Analytic column storage for PostgreSQL, built as a native table access method.
site_url: https://commandprompt.github.io/pgcolumnar/
site_author: pgColumnar contributors

repo_url: https://github.com/commandprompt/pgcolumnar
repo_name: commandprompt/pgcolumnar
edit_uri: edit/main/docs/

copyright: >
  pgColumnar is released under the MIT License. PostgreSQL is a trademark of the
  PostgreSQL Community Association of Canada.

theme:
  name: material
  logo: assets/pgcolumnar-mark.svg
  favicon: assets/pgcolumnar-mark.svg
  icon:
    repo: fontawesome/brands/github
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

extra_css:
  - stylesheets/brand.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/commandprompt/pgcolumnar
      name: pgColumnar on GitHub
  generator: false

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

nav:
  - Home: index.md
  - Getting started:
      - Installation: installation.md
      - User guide: user-guide.md
      - How-to guides: how-to.md
      - Best practices: best-practices.md
  - Concepts:
      - Features: features.md
      - Architecture: ARCHITECTURE.md
  - Operations:
      - Administration: administration.md
      - Configuration: configuration.md
      - Benchmarks: benchmarks.md
  - Reference:
      - SQL reference: sql-reference.md
      - Limitations & compatibility: limitations.md
  - Development:
      - Roadmap: roadmap.md
      - Testing: testing.md