katal/mkdocs.yml at main · najamcodes/katal · 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
site_name: Katal
site_description: A simple yet powerful web framework for Bun with TypeScript
site_url: ""
repo_url: https://github.com/najamcodes/katal
repo_name: katal
site_dir: docs
docs_dir: docs_src
theme:
  name: readthedocs

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true

plugins:
  - search

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Core:
    - Application & Router: CORE.md
    - Controllers & HTTP: HTTP.md
    - Dependency Injection: DI.md
  - Features:
    - Middleware: MIDDLEWARE.md
    - Validation: VALIDATION.md
    - Authentication: AUTH.md
    - Authorization: AUTHORIZATION.md
    - Rate Limiting: RATE_LIMITING.md
    - Logging: LOGGING.md
    - Observability: OBSERVABILITY.md
    - Cache: CACHE.md
    - Events: EVENTS.md
    - Health Checks: HEALTH.md
    - Queue: QUEUE.md
    - OpenAPI: OPENAPI.md
    - Config: CONFIG.md
  - Extension:
    - Plugins: PLUGINS.md
    - Service Providers: SERVICE_PROVIDERS.md
  - Testing: TESTING.md
  - Examples:
    - Simple App: examples/simple.md
    - Custom Controllers: examples/custom-base-controllers.md
    - Middleware Hooks: examples/middleware-hooks.md