google-python-style-guide-kr/mkdocs.yml at main · trivialcoding6/google-python-style-guide-kr · 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
site_name: "Google Python Style Guide - 한글 번역"
site_description: "Google Python Style Guide의 한글 번역 프로젝트"
site_author: Gideok Kim
site_url: https://gideokkim.github.io/google-python-style-guide-kr/

repo_name: GideokKim/google-python-style-guide-kr
repo_url: https://github.com/GideokKim/google-python-style-guide-kr

copyright: "© 2025 Google - Licensed under Apache License 2.0"

# Theme 설정
theme:
  name: material
  language: ko
  features:
    - navigation.tabs           # 상단 탭 네비게이션
    - navigation.sections       # 섹션 접기/펼치기
    - navigation.top           # "맨 위로" 버튼
    - search.suggest          # 검색 제안
    - search.highlight        # 검색 결과 하이라이트
    - content.tabs.link       # 탭 간 이동
    - content.code.copy       # 코드 복사 버튼

  # 폰트 설정
  font:
    text: Nanum Gothic
    code: Nanum Gothic Coding

  # 색상 테마
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to light mode

# Extensions
markdown_extensions:
  - admonition              # 경고, 참고 등 박스
  - pymdownx.details        # 접기/펼치기
  - pymdownx.superfences    # 다양한 코드 블록
  - pymdownx.highlight:     # 코드 하이라이팅
      anchor_linenums: true
  - pymdownx.inlinehilite  # 인라인 코드 하이라이팅
  - pymdownx.snippets      # 코드 스니펫
  - pymdownx.tabbed:       # 탭
      alternate_style: true
  - attr_list              # 이미지 속성
  - md_in_html            # HTML 내 마크다운
  - footnotes             # 각주
  - tables                # 테이블
  - toc:                  # 목차
      permalink: true

# Plugins
plugins:
  - search:
      lang:
        - en
        - ko

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/GideokKim
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY

# Navigation
docs_dir: google python style guide
nav:
  - 배경: background.md
  - Python Language Rules:
    - Lint: lint.md
    - Imports: imports.md