guardian/mkdocs.yml at main · gnarzilla/guardian · 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
# mkdocs.yml
site_name: Guardian
site_description: Git Authentication & Development Assistant
theme:
  name: material
  palette:
    primary: indigo
    accent: cyan
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - def_list

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - Authentication:
      - SSH Keys: user-guide/auth/ssh.md
      - GitHub Tokens: user-guide/auth/tokens.md
      - GPG Keys: user-guide/auth/gpg.md
    - Repository Management:
      - Initialization: user-guide/repo/init.md
      - Templates: user-guide/repo/templates.md
      - Hooks: user-guide/repo/hooks.md
    - Security:
      - Scanning: user-guide/security/scanning.md
      - Key Management: user-guide/security/keys.md
      - Best Practices: user-guide/security/best-practices.md
  - API Reference:
    - Auth Service: api/auth.md
    - Config Service: api/config.md
    - Repo Service: api/repo.md
    - Security Service: api/security.md
  - Contributing:
    - Development Setup: contributing/setup.md
    - Code Style: contributing/style.md
    - Testing: contributing/testing.md
  - Roadmap: roadmap.md