187 lines
5.7 KiB
YAML
187 lines
5.7 KiB
YAML
# 사이트 기본 설정
|
|
site_name: Quad 한국어 문서
|
|
site_url: https://quad.qwreey.kr/kr/
|
|
site_author: Qwreey and more
|
|
site_description: Description for Quad. (Korean)
|
|
copyright: Copyright © 2020 - 2023 Qwreey
|
|
|
|
# 사이드바
|
|
nav:
|
|
- 홈:
|
|
- 'index.md'
|
|
- 갤러리: 'gallery.md'
|
|
- 변경사항: 'changelogs.md'
|
|
- 라이선스: 'license.md'
|
|
- 로드맵: 'todo.md'
|
|
- 튜토리얼:
|
|
- tutorial/index.md
|
|
- Import: 'tutorial/1_import.md'
|
|
- Mount: 'tutorial/2_mount.md'
|
|
- GetObject: 'tutorial/3_getObject.md'
|
|
- Style: 'tutorial/4_style.md'
|
|
- Event: 'tutorial/5_event.md'
|
|
- Tween: 'tutorial/6_tween.md'
|
|
- QuadProperty: 'tutorial/7_quadProperty.md'
|
|
- Register: 'tutorial/8_register.md'
|
|
- Lang: 'tutorial/9_lang.md'
|
|
- Signal: 'tutorial/10_signal.md'
|
|
- Extend: 'tutorial/11_extend.md'
|
|
- 레퍼런스:
|
|
- 'reference/index.md'
|
|
- Signal:
|
|
- 'reference/signal/index.md'
|
|
- Bindable: 'reference/signal/bindable.md'
|
|
- Disconnecter: 'reference/signal/disconnecter.md'
|
|
- Store:
|
|
- 'reference/store/index.md'
|
|
- ObjectList: 'reference/store/objectList.md'
|
|
- Tween:
|
|
- 'reference/tween/index.md'
|
|
- TweenOptions: 'reference/tween/tweenOptions.md'
|
|
- Easings: 'reference/tween/easings.md'
|
|
- Directions: 'reference/tween/directions.md'
|
|
- Event: 'reference/event.md'
|
|
- Extend: 'reference/extend.md'
|
|
- Lang: 'reference/lang.md'
|
|
- Mounts: 'reference/mounts.md'
|
|
- QuadProperty: 'reference/quadProperty.md'
|
|
|
|
extra:
|
|
# 다중 언어 설정
|
|
alternate:
|
|
- name: 한국어
|
|
link: /kr/
|
|
lang: ko
|
|
- name: English
|
|
link: /en/
|
|
lang: en
|
|
# 소셜 링크
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/qwreey75
|
|
- icon: fontawesome/brands/mastodon
|
|
link: https://stella.place/@qwreey
|
|
|
|
# 리포 설정
|
|
repo_url: https://github.com/qwreey75/Quad
|
|
repo_name: Quad
|
|
remote_branch: master
|
|
|
|
# 사이트dir 설정, 저장소 하나로 관리하기 위해서 이렇게 씀
|
|
docs_dir: md/kr
|
|
site_dir: docs/kr
|
|
|
|
# 검색엔진 설정
|
|
lang: multi # 한글이 없어서 어쩔 수 없이 묶음으로 사용
|
|
min_search_length: 2 # 최소 검색 단위
|
|
|
|
# 테스팅 사이트 설정(로컬 서버)
|
|
dev_addr: '127.0.0.1:8080'
|
|
|
|
# 추가 Css
|
|
extra_css:
|
|
- assets/extra.css
|
|
|
|
# 다른 설정
|
|
#extra:
|
|
# disqus: luakrdoc # 디스커스 설정
|
|
|
|
# 테마링
|
|
theme:
|
|
# 기본 설정
|
|
name: material
|
|
# mkdocs 덮어쓰기 폴더(일반적으로 없어도 됨)
|
|
# custom_dir: overrides
|
|
|
|
# 테마
|
|
palette:
|
|
- scheme: darker
|
|
toggle:
|
|
icon: material/brightness-3
|
|
name: 밝은 테마로 변경
|
|
# - scheme: dark
|
|
# toggle:
|
|
# icon: material/brightness-4
|
|
# name: Switch to light theme
|
|
- scheme: default
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: 어두운 테마로 변경
|
|
|
|
# 세부기능 Flag
|
|
features:
|
|
- navigation.indexes
|
|
- navigation.footer # 바닥에 다음글 표시
|
|
- navigation.tabs # 최상위 nav 인덱스를 탭으로 이동
|
|
- navigation.top # 맨 위로 올라가기 표시
|
|
- toc.integrate # 목차를 네비게이션에 합치기
|
|
- content.code.copy # 코드 복사버튼
|
|
|
|
# 결과 없음 페이지
|
|
static_templates:
|
|
- 404.html
|
|
|
|
# 언어/폰트
|
|
language: ko
|
|
font: false
|
|
|
|
# 아이콘
|
|
favicon: assets/Quad_MiniLogo.png
|
|
logo: assets/Quad_MiniLogoWhite.svg
|
|
|
|
# 일부 설정
|
|
include_search_page: false
|
|
search_index_only: true
|
|
|
|
plugins:
|
|
- search
|
|
|
|
# Markdown 플러그인
|
|
markdown_extensions:
|
|
# 컴포넌트
|
|
- pymdownx.tabbed: # 탭
|
|
alternate_style: true
|
|
- admonition # 노트라인
|
|
- pymdownx.details # 더보기(확장 가능한 라벨)
|
|
- pymdownx.progressbar # 프로그래스 바
|
|
- attr_list # ID 붙이기
|
|
- def_list # 기본 리스트
|
|
|
|
# 기초 설정
|
|
- footnotes # 바닥글
|
|
- pymdownx.superfences # 스페이스 관련, 펜스 중첩허용
|
|
- pymdownx.keys # 단축키(검색)
|
|
- pymdownx.magiclink # 링크 확장기
|
|
- pymdownx.inlinehilite # 인라인 코드 하이라이팅
|
|
- pymdownx.mark # 마킹(형광마커 효과)
|
|
- md_in_html # div 같은거 안에 마크다운 작성
|
|
- pymdownx.highlight: # 코드 구문강조
|
|
linenums: true # 코드라인 넘버
|
|
- pymdownx.emoji: # 이모지 불러오기
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
- pymdownx.tasklist: # 체크박스 불러오기
|
|
custom_checkbox: true
|
|
- pymdownx.betterem: # 더 나은 글자 서식 알고리즘
|
|
smart_enable: all
|
|
- pymdownx.smartsymbols: # 특수문자 쉬운입력
|
|
fractions: false
|
|
- markdown_include.include: # 다른 md 파일 가져와서 보여주기
|
|
base_path: md/kr
|
|
|
|
# 기타 세부 설정
|
|
- codehilite: # 코드 언어 추측 끄기
|
|
guess_lang: false
|
|
- toc: # 부분 링크 허용
|
|
permalink: true
|
|
- meta # 메타데이터 관련
|
|
|
|
# 사용되지 않는 플러그인
|
|
#- pymdownx.snippets # 외부 md 로더
|
|
#- pymdownx.tilde #아래첨자 단순화
|
|
#- pymdownx.arithmatex # 수학적 표현 표시
|
|
#- pymdownx.caret # ^ 기호로 글자 서식 추가
|
|
#- pymdownx.critic # 내용추가,제거,비평 하이라이터
|
|
#- pymdownx.b64 # base64 로 이미지를 html에 임베드
|
|
#- pymdownx.escapeall # 모든 이스캐이프 허용
|
|
#- abbr # 줄임말 표현 세부정보 붇이기
|