building-openapis/mkdocs.yml at master · kenjones-cisco/building-openapis · 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
docs_dir: content
site_dir: docs
site_name: Building OpenAPIs
site_author: Kenny Jones

repo_name: 'kenjones-cisco/building-openapis'
repo_url: 'https://github.com/kenjones-cisco/building-openapis'

theme: 'material'

extra_css:
  - 'stylesheets/font-awesome.css'

pages:
  - Overview: index.md
  - References:
    - REST APIs: references/rest.md
    - OpenAPI: references/openapi.md
    - API Design: references/design.md
    - API Development: references/development.md
  - Best Practices:
    - API Design: best-practices/design.md
    - API Implementation: best-practices/implementation.md
  - Tutorials:
    - Setup: tutorials/setup.md
    - Generating Server Stubs:
      - Golang API Server: tutorials/server_golang.md
      - Java API Server: tutorials/server_java.md
      - Python API Server: tutorials/server_python.md
    - Generating Clients:
      - Golang API Client: tutorials/client_golang.md
      - Java API Client: tutorials/client_java.md
      - Python API Client: tutorials/client_python.md
      - Postman API Client: tutorials/client_postman.md
    - Generating Documentation: tutorials/documentation.md
    - API Security: tutorials/security.md
    - Correlation Id: tutorials/correlation_id.md
  - License: license.md

markdown_extensions:
  - markdown_include.include:
      base_path: content
  - toc(permalink=true)
  - admonition
  - codehilite
  - fontawesome_markdown