mixerapi-dev/mkdocs.yml at master · mixerapi/mixerapi-dev · 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
site_name: CakePHP RESTful API plugin
docs_dir: docs
plugins:
- simple:
    include_files:
    - .svg
- search
- exclude:
    glob:
    - vendor/*
    - tmp/*
    - plugins/bake/webroot/*
    - plugins/bake/tests/*
    - plugins/collection-view/webroot/*
    - plugins/collection-view/tests/*
    - plugins/core/*
    - plugins/crud/tests/*
    - plugins/crud/webroot/*
    - plugins/exception-render/webroot/*
    - plugins/exception-render/tests/*
    - plugins/hal-view/webroot/*
    - plugins/hal-view/tests/*
    - plugins/json-ld-view/webroot/*
    - plugins/json-ld-view/tests/*
    - plugins/jwt-auth/webroot/*
    - plugins/jwt-auth/tests/*
    - plugins/mixerapi/webroot/*
    - plugins/mixerapi/tests/*
    - plugins/rest/webroot/*
    - plugins/rest/tests/*
site_description: MixerAPI streamlines development of RESTful APIs for your CakePHP
  project.
repo_url: https://github.com/mixerapi/mixerapi
edit_uri: ''
theme:
  name: material
  palette:
    scheme: default
    primary: red
    accent: red
  font:
    text: Roboto
    code: Roboto Mono
  features:
  - navigation.expand
  favicon: images/favicon.png
  logo: assets/logo.png
nav:
- Install: /install
- Workflow: /workflow
- Baking Controllers: /plugins/bake
- Crud Services: /plugins/crud
- Event Listeners: /event-listeners
- Exception Rendering: /plugins/exception-render
- JWT Authentication: /plugins/jwt-auth
- OpenAPI (Swagger):
  - Documentation: /plugins/cakephp-swagger-bake
  - Attributes: /plugins/cakephp-swagger-bake/docs/attributes
  - Events: /plugins/cakephp-swagger-bake/docs/events
  - Extensions: /plugins/cakephp-swagger-bake/docs/extensions
- Response Formats:
  - JSON / XML: /plugins/collection-view
  - HAL+JSON: /plugins/hal-view
  - JSON-LD: /plugins/json-ld-view
- RESTful Routes: /plugins/rest
- Search: /friends-of-cake-search
markdown_extensions:
- attr_list
- admonition
- meta
- pymdownx.details
- pymdownx.highlight:
    extend_pygments_lang:
    - name: php
      lang: php
      options:
        startinline: true
    - name: pycon3
      lang: pycon
      options:
        python3: true
    linenums_style: pymdownx-inline
- pymdownx.superfences:
    preserve_tabs: true
extra:
  social:
  - icon: fontawesome/brands/slack
    link: https://cakesf.slack.com/
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/mixerapi
  - icon: fontawesome/brands/github
    link: https://github.com/mixerapi