mimicker/mkdocs.yml at main · mimickerhq/mimicker · 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
site_name: Mimicker
site_description: Lightweight Python-native HTTP mock server for testing and CI/CD
site_url: https://mimickerhq.github.io/mimicker
repo_url: https://github.com/mimickerhq/mimicker
repo_name: mimickerhq/mimicker

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.integrate

nav:
  - Home: index.md
  - Get Started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - Guides:
      - Stubbing Guide: guides/stubbing-guide.md
      - Path & Query Params: guides/path-and-query-params.md
      - Dynamic Responses: guides/dynamic-responses.md
  - CI/CD:
      - Docker: ci-cd/docker.md
      - GitHub Actions: ci-cd/github-actions.md
      - GitLab CI: ci-cd/gitlab-ci.md
      - docker-compose: ci-cd/docker-compose.md
      - Stub Coverage Reports: ci-cd/stub-coverage-reports.md
  - Reference:
      - CLI Reference: reference/cli-reference.md
      - Stub File Schema: reference/stub-file-schema.md
      - Python API: reference/python-api.md
  - Contributing: contributing.md

markdown_extensions:
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mimickerhq/mimicker
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/mimicker/
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/mimicker/shared_invite/zt-2yr7vubw4-8Y09YyxZ5j~G2tlQ5uOXKw