DeltaDatabase/mkdocs.yml at main · DeltaRule/DeltaDatabase · 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
site_name: DeltaDatabase
site_description: A lightweight, encrypted-at-rest JSON database written in Go
site_url: https://deltadatabase.readthedocs.io
repo_url: https://github.com/DeltaRule/DeltaDatabase
repo_name: DeltaRule/DeltaDatabase

theme:
  name: readthedocs

docs_dir: docs

nav:
  - Home: index.md
  - Changelog: changelog.md
  - Usage:
      - Overview: usage/index.md
      - Quick Start: usage/quickstart.md
      - Configuration: usage/configuration.md
      - API Reference: usage/api-reference.md
      - Authentication: usage/authentication.md
      - JSON Schema Templates: usage/schemas.md
      - Deployment: usage/deployment.md
      - Security Model: usage/security.md
      - Management UI: usage/frontend.md
      - Caching Model: usage/caching.md
      - Benchmark Results: usage/benchmarks.md
      - Examples:
          - Overview: usage/examples/index.md
          - Chat Application: usage/examples/chat-app.md
          - User Profiles: usage/examples/user-profiles.md
          - IoT Sensor Data: usage/examples/iot-sensors.md
          - Configuration Store: usage/examples/config-store.md
          - E-Commerce Catalogue: usage/examples/ecommerce.md
  - Development:
      - Overview: development/index.md
      - Architecture: development/architecture.md
      - Project Structure: development/project-structure.md
      - Building from Source: development/building.md
      - Testing: development/testing.md

markdown_extensions:
  - admonition
  - tables
  - fenced_code
  - codehilite
  - toc:
      permalink: true