docs/mkdocs.yml at master · grip-framework/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
# Project Information
site_name: Grip framework
site_url: https://grip-framework.github.io/docs
site_author: Grip framework and its contributors
site_description: Grip documentation (web framework for Crystal).

# Repository
repo_name: Grip Github
repo_url: https://github.com/grip-framework/grip
edit_uri: https://github.com/grip-framework/docs/tree/master/docs/

# Copyright
copyright: "Copyright &copy; Grip framework and its contributors 2019-2026"

# Configuration
theme:
  name: material
  language: en

  palette:
    primary: white

  logo: https://github.com/grip-framework/medias/raw/master/grip_avatar.png
  favicon: https://github.com/grip-framework/medias/raw/master/grip_avatar.png

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/grip-framework/grip

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - footnotes
  - meta
  - toc:
      permalink: true

nav:
  - Introduction:
      - Prelude: "index.md"
      - Installation: "installation.md"
      - Getting Started: "getting_started.md"
  - Application: "application.md"
  - Context: "context.md"
  - Routing:
      - Basic routing: "basic_routing.md"
      - Advanced routing: "advanced_routing.md"
      - Scope: "scope.md"
      - Forward: "forward.md"
      - WebSocket routing: "web_socket_routing.md"
      - Available verbs: "verbs.md"
  - Runtime flags: "runtime_flags.md"
  - Middleware: "pipe_middleware.md"
  - Error handling: "error_handling.md"
  - SSL: "ssl.md"
  - Deployment: "deployment.md"
  - Testing: "testing.md"