mkdocs.yml 1.47 KB
Newer Older
1
site_name: Unified Ticketing Docs
Lukas Wiest's avatar
Lukas Wiest committed
2

3
repo_name: 'Code on Transfer Portal'
Lukas Wiest's avatar
Lukas Wiest committed
4
5
repo_url: 'https://transfer.hft-stuttgart.de/gitlab/9Lukas5/unified-ticketing'
edit_uri: 'blob/master/docs/'
Lukas Wiest's avatar
Lukas Wiest committed
6
7
docs_dir: docs

8
copyright: 'Copyright © 2020 University for Applied Sciences Stuttgart'
Lukas Wiest's avatar
Lukas Wiest committed
9

Lukas Wiest's avatar
Lukas Wiest committed
10
11
12
use_directory_urls: false

nav:
13
  - Index: 'index.md'
Lukas Wiest's avatar
Lukas Wiest committed
14
15
  - Home:
    - Index: 'index.md'
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
    - Changelog: 'unified-ticketing/changelog-softlink.md'
    - Usage: 'unified-ticketing/usage.md'
    - Contributing: 'unified-ticketing/contributing.md'
    - License: 'unified-ticketing/license-softlink.md'
  - API:
    - Index: 'api/index.md'
    - Core:
      - Logging: 'api/core/logging.md'
      - Ticket: 'api/core/ticket.md'
      - Ticketsystem: 'api/core/ticket-system.md'
    - Exceptions: 'api/exceptions.md'
    - Systems:
        - GitLab:
          - Ticket: 'api/systems/gitlab/ticket.md'
          - Ticketsystem: 'api/systems/gitlab/ticket-system.md'
  - Developers Guide:
32
    - Index: 'developers-guide.md'
Lukas Wiest's avatar
Lukas Wiest committed
33
34
35
36
37
38
39
40
41
42
43
44
45

theme:
  name: 'material'
  palette:
    primary: 'white'
    accent: 'teal'
  language: 'en'
  feature:
    tabs: true
  logo:
    icon: library_books

markdown_extensions:
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
  - admonition
  - codehilite:
      linenums: true
  - toc:
      permalink: True
  - footnotes
  - tables
  - plantuml_markdown:
      server: http://plantuml.com/plantuml
      format: svg
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.tasklist
  - pymdownx.details
  - pymdownx.superfences