sdk.conreality.dev/mkdocs.yml at master · Conreality/sdk.conreality.dev · 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
# See: https://www.mkdocs.org/user-guide/configuration/

# Site configuration:
site_name: Conreality Software Development Kit (SDK)
site_author: Conreality Ltd
site_url: https://sdk.conreality.dev
repo_url: https://github.com/conreality/sdk.conreality.dev
google_analytics:

# Content configuration:
remote_name: github
docs_dir: content
site_dir: public
use_directory_urls: false

# Theme configuration:
theme: material

# Plugin configuration:
plugins:
  - search
  - macros
  - mermaid2:
      arguments:
        theme: neutral

# Table of contents (TOC):
nav:
  - Introduction: index.md
  - Installation:
    - Linux: install/linux.md
    - macOS: install/macos.md
    - Windows: install/windows.md
  - Getting Started: start.md
  - Concepts: concepts.md
  - Tutorials: learn/index.md
  - Languages:
    - C: c/README.md
    - C++: cpp/README.md
  - FAQs:
    - General Questions: faq/general.md
  - Release Notes: history.md
  - Glossary: glossary.md

# Mermaid plugin configuration:
extra_javascript:
  - https://unpkg.com/mermaid@8.5.2/dist/mermaid.min.js