guidelines/mkdocs.yml at master · cortside/guidelines · 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
site_name: Cortside Guidelines
site_description: General guidelines by Cortside
site_url: https://www.cortside.com
site_author: Cort Schaefer
repo_url: https://github.com/cortside/guidelines
edit_uri: edit/develop/docs

#theme: material
#theme: readthedocs
theme:
  name: material
  custom_dir: material

  # Static files
  static_templates:
    - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    # - navigation.instant
    - navigation.sections
    - navigation.tabs
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  icon:
    logo: logo

nav:
  - 'Architecture':
    - 'Microservices': architecture/Microservices.md
    - 'Messaging': architecture/Messaging.md
    - 'REST': architecture/REST.md
    - 'Security': architecture/Security.md
    - 'Observability': architecture/Observability.md
    - 'Token Exchange': architecture/TokenExchange.md
    - 'References': architecture/References.md
  - RESTful API Design:
    - 'TL;DR Best Practices': rest/BestPractices.md
    - rest/Resource.md
    - rest/Representation.md
    - rest/Errors.md
    - rest/HTTPStatusCodes.md
    - rest/HealthCheck.md
    - rest/OpenAPI.md
#  - C#:
#    - csharp/CodingStandards.md
  - SQL: sql/README.md
  - Git: git/README.md
  - Template projects: template/TemplateApi.md
#  - Scrum: scrum/user-stories.md

# ci for docs
# https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/

#extra_css:
#    - css/extra.css

plugins:
    - search
    - minify:
        minify_html: true
#    - extra-sass
#    -  pdf-export:
#        combined: true
#        combined_output_path: combined.pdf
#    - mkpdfs:
#        company: The War Company Inc.
#        author: Monsieur Silvestre
#        toc_title: ToC
    - with-pdf:
        author: Cort Schaefer
        #copyright: Copyright (c) 2021 Cortside Consulting
        #
        #cover: false
        #back_cover: true
        cover_title: Architecture Guidelines
        cover_subtitle: The First Book of Cort
        #custom_template_path: TEMPLATES PATH
        cover_logo: grumpy.png
        #
        #toc_title: TOC TITLE TEXT
        #heading_shift: false
        #toc_level: 3
        #ordered_chapter_level: 2
        #excludes_children:
        #    - 'release-notes/:upgrading'
        #    - 'release-notes/:changelog'
        #
        #exclude_pages:
        #    - 'bugs/'
        #    - 'appendix/contribute/'
        #convert_iframe:
        #    - src: IFRAME SRC
        #      img: POSTER IMAGE URL
        #      text: ALTERNATE TEXT
        #    - src: ...
        #two_columns_level: 3
        #
        #render_js: true
        #headless_chrome_path: google-chrome
        #
        output_path: ../guidelines.pdf
        #enabled_if_env: ENABLE_PDF_EXPORT
        #
        #debug_html: true
        #show_anchors: true
        #verbose: true

markdown_extensions:
#   - extra
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - toc:
      permalink: 
      toc_depth: 3
  - codehilite
  - pymdownx.tabbed
  - pymdownx.superfences
  - markdown_include.include:
      base_path: docs
  - admonition
  - footnotes
  - def_list
  - abbr
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.keys
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - meta
  - smarty
  - attr_list