netID-docs/mkdocs.yml at master · 1701/netID-docs · 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
# Project information
site_name: 'netID Developer Zone'
site_description: 'Developer Zone for netID, the european login standard of the European netID Foundation'
site_author: 'European netID Foundation'
site_url: 'https://eunid.github.io/netID-docs/'

# Theme Configuration
theme:
  name: 'material'
  language: 'en'
  palette:
    primary: '#76B82A'
    accent: '#545454'
  font:
    text: 'IBM Plex Sans'
    code: 'Roboto Mono'
  logo: 'images/logo.png'
  favicon: 'images/favicon.ico'
  custom_dir: custom_theme/
  features:
    - tabs

# Github Repo
# repo_name: 'eunid/netID-docs'
# repo_url: 'https://github.com/eunid/netID-docs/'

# Site Navigation
nav:
    - About netID: index.md
    - Developer Portal:
        - Getting started: devportal/get_started.md
        - Tutorials:
            - Services: devportal/tutorial/services.md
            - Clients: devportal/tutorial/clients.md
            - User Management: devportal/tutorial/users.md
            - Test User: devportal/tutorial/testuser.md
        - KPI Reports: devportal/reporting.md
    - Single Sign-on Integration:
        - Technical Details: sso/doc_sso_developer.md
        - Styleguide: sso/styleguide.md
        - Plugins: sso/plugins.md
 #   - CMP Integration:
 #       - General information: cmp/index.md
 #       - Browser-based API: cmp/browser-based.md
 #       - Server-based API: cmp/server-based.md
 #       - Data export API: cmp/export.md
 #   - Glossary: glossary.md
    - FAQ: faq.md

# Extensions
markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed
  - pymdownx.tilde


# PlantUML
plugins:
  - search
  - build_plantuml:
      render: "server" # or "local" for local rendering
      bin_path: "/usr/local/bin/plantuml" # ignored when render: server
      server: "http://www.plantuml.com/plantuml" # offical plantuml server
      output_format: "svg" # or "png"
      diagram_root: "docs/diagrams" # should reside under docs_dir
      output_folder: "out"
      input_folder: "src"

    # Override CSS
extra_css:
  - 'stylesheets/extra.css'