api-log/mkdocs.yml at master · devslab-kr/api-log · 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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
site_name: api-log
site_url: https://api-log.devslab.kr/
site_description: Event-driven API call logging for Spring Boot — async event pipeline with PostgreSQL JSONB storage.
site_author: Devslab
copyright: Copyright &copy; 2026 Devslab. Licensed under Apache 2.0.

repo_url: https://github.com/devslab-kr/api-log
repo_name: devslab-kr/api-log
edit_uri: edit/master/docs/

docs_dir: docs

theme:
  name: material
  language: en
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
  palette:
    # `custom` activates the CSS-variable-driven palette defined in
    # docs/stylesheets/extra.css (matches devslab.kr brand colors).
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: ko
          name: 한국어
          build: true
          nav_translations:
            Home: 홈
            Getting Started: 시작하기
            Installation: 설치
            Quickstart: 빠른 시작
            Guides: 가이드
            Backends: 백엔드
            JPA Backend: JPA 백엔드
            R2DBC Backend: R2DBC 백엔드
            MyBatis Backend: MyBatis 백엔드
            Using RestApiClient: RestApiClient 사용하기
            Reactive (WebFlux): 리액티브 (WebFlux)
            Publishing Events: 이벤트 직접 발행
            Retry Handling: 재시도 처리
            Querying Logs: 로그 조회
            Reference: 레퍼런스
            Configuration: 설정
            Schema: 스키마
            Events: 이벤트
            Changelog: 변경 이력
            Contributing: 기여하기

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - tables
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
      toc_depth: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/devslab-kr/api-log
    - icon: fontawesome/solid/globe
      link: https://devslab.kr
  alternate:
    - name: English
      link: /
      lang: en
    - name: 한국어
      link: /ko/
      lang: ko

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - Guides:
      - Backends:
          - JPA Backend: guides/jpa-backend.md
          - R2DBC Backend: guides/r2dbc-backend.md
          - MyBatis Backend: guides/mybatis-backend.md
      - Using RestApiClient: guides/using-restapiclient.md
      - Reactive (WebFlux): guides/reactive.md
      - Publishing Events: guides/publishing-events.md
      - Retry Handling: guides/retry-handling.md
      - Querying Logs: guides/querying-logs.md
  - Reference:
      - Configuration: reference/configuration.md
      - Schema: reference/schema.md
      - Events: reference/events.md
  - Changelog: changelog.md
  - Contributing: contributing.md