docs: Mkdocs 문서 설명 추가 (#6)

Author: cpprhtn

.gitignore

@@ -0,0 +1 @@
+/site

README.md

@@ -1,36 +1,115 @@
-파이콘 한국 행동강령 PyCon KR Code of Conduct 
-=====================
+# mkdocs 브랜치 문서
 
-이 저장소는 [파이콘 한국 행동강령(국문)](https://github.com/pythonkr/pycon-code-of-conduct/blob/korean/code_of_conduct.md) / [PyCon Korea CoC (Eng)](https://github.com/pythonkr/pycon-code-of-conduct/blob/english/code_of_conduct.md) 을 포함하여 스태프들과 참가자들을 위한 가이드라인을 포함하고 있습니다.
+이 브랜치는 **파이콘 한국 행동강령 페이지**를 위해 Python으로 이루어진 [MkDocs](https://www.mkdocs.org/)를 사용하며, `mkdocs.yml` 설정 파일과 관련 파일들을 관리합니다.
+python 3.11 버전에서 테스트되고 작성되었습니다.
 
-파이콘 한국은:
-- 누구나 편안하게 참여할 수 있는 행사를 지향합니다.
-- 서로 다름을 인정하고 존중하는 분위기를 지향합니다.
-- 성별, 성적 지향, 성 정체성, 국적, 인종, 지역, 종교, 나이, 사회적 신분, 학력, 지식 수준, 외모, 장애, 질병, 음식 선호 등과 관계 없이 모든 참가자가 동등한 컨퍼런스를 지향합니다.
-- 서로 환영하는 분위기를 독려합니다.
+---
 
-파이콘 한국 행동강령은 더 나은 커뮤니티를 위해 계속해서 변화하고 있습니다. 파이콘 한국 준비위원회와 많은 사람들의 노력에도 불구하고, 본 행동강령에는 여전히 개선할 점이 존재합니다.  
+## 브랜치 목적
 
-행동강령을 개선하는 과정에 여러분도 동참할 수 있습니다. 제안, 의견 혹은 행동강령과 관련된 어떠한 내용이라도 언제든지 자유롭게 [[email protected]](mailto:[email protected]) 로 보내주세요. 보내주신 의견은 준비위원회가 면밀히 검토하겠습니다.  
+- `mkdocs` 브랜치:
+  프로젝트의 문서 소스를 관리합니다.
+  MkDocs 설정(`mkdocs.yml`), 문서 마크다운 파일(`docs/` 폴더), 테마, 플러그인 등이 포함됩니다.
+- `gh-pages` 브랜치 (참고):
+  MkDocs로 빌드한 정적 HTML 파일이 배포되는 브랜치입니다.
+  GitHub Pages가 `gh-pages` 브랜치의 내용을 호스팅하여 웹사이트를 제공합니다.
 
-파이콘 한국 준비위원회는 투명성과 기록의 가치를 믿습니다. 행동강령에 변경 사항이 있다면 그 내역을 모두 기록하고 웹사이트를 통해 공개할 것입니다.   
+---
 
-## mkdocs build
-### 1. install mkdocs
+## 디렉토리 구조
+
+```plaintext
+├── docs/             # 마크다운 형식의 실제 문서들
+│   ├── index.md      # 사이트의 홈 페이지
+│   └── ...           # 추가 문서들
+├── mkdocs.yml        # MkDocs 사이트 설정 파일
+├── requirements.txt  # MkDocs 및 관련 플러그인 설치 목록
 ```
+
+또한 `docs/en`, `docs/ko` 디렉토리를 구분하여 i18n 다국어 지원을 제공합니다.
+
+---
+
+## `mkdocs.yml` 설명
+
+`mkdocs.yml`은 MkDocs의 핵심 설정 파일로, 다음 정보를 포함합니다:
+
+| 설정 항목             | 설명                                                          |
+| --------------------- | ------------------------------------------------------------- |
+| `site_name`           | 사이트 이름 (문서 웹사이트 제목)                              |
+| `nav`                 | 네비게이션 메뉴 구성 (`index.md` 등 문서의 순서 및 구조 설정) |
+| `theme`               | 사이트 테마 (예: `material` 테마)                             |
+| `plugins`             | MkDocs 플러그인 설정 (검색, 코드 하이라이트 등)               |
+| `markdown_extensions` | 추가 마크다운 확장 기능 설정                                  |
+
+| 설정 항목             | 설명                                                                                              |
+| --------------------- | ------------------------------------------------------------------------------------------------- |
+| `site_name`           | 사이트 이름 (문서 웹사이트 제목)                                                                  |
+| `theme`               | 사이트 테마에 대한 설정                                                                           |
+| ├─ `name`             | 사용할 테마 이름 (`material`).                                                                    |
+| ├─ `logo`             | 사이트 로고 파일 경로.                                                                            |
+| ├─ `features`         | 활성화할 추가 UI 기능 (탭, 섹션, 상단 메뉴, TOC 통합, 검색 추천/하이라이트, 코드 주석 등).        |
+| ├─ `language`         | 사이트 기본 언어.                                                                                 |
+| ├─ `palette`          | 밝은 모드(`default`)와 어두운 모드(`slate`)의 색상 테마 구성.                                     |
+| `nav`                 | 네비게이션 메뉴 구성 (`index.md` 등 문서의 순서 및 구조 설정)                                     |
+| `extra`               | GitHub, Twitter, Instagram 소셜 아이콘 등의 추가요소를 설정.                                      |
+| `markdown_extensions` | Markdown 문법 확장 기능 설정. 코드 하이라이트, 수학, 각주, 아코디언 등의 기능을 활성화할 수 있음. |
+| `copyright`           | 사이트 하단에 표시될 저작권 문구.                                                                 |
+
+---
+
+## MkDocs 사용 방법
+
+### 의존성 설치
+
+```bash
 pip install -r requirements.txt
 ```
 
-### 2. run
-```
+---
+
+### 로컬 서버 실행
+
+```bash
 mkdocs serve
 ```
 
-### 3. open website
+- 문서 변경 사항이 자동 반영됩니다.
+- 기본 포트는 `8000`입니다.
+
+---
+
+### 로컬에서 문서 사이트 확인
+
+브라우저에서 아래 주소를 열어주세요:
+
 ```
 http://127.0.0.1:8000/
 ```
 
-[릴리즈 노트](https://github.com/pythonkr/pycon-code-of-conduct/releases)  
-      
+---
+
+## 빌드 및 배포 (참고)
+
+- 문서를 빌드하기전에 로컬에서 제대로 빌드되는지 확인해주세요:
+
+  ```bash
+  mkdocs build
+  ```
+
+  --> `site/` 폴더에 정적 HTML 파일 생성
+
+- `mkdocs` 브랜치에 commit을 완료하면 Github Action을 통해 `gh-pages` 브랜치에서 배포가 완료됩니다.
+
+---
+
+## 참고 링크
+
+- [MkDocs 공식 문서](https://www.mkdocs.org/)
+- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
+
+---
+
+[릴리즈 노트](https://github.com/pythonkr/pycon-code-of-conduct/releases)
+
 <a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="크리에이티브 커먼즈 라이선스" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />이 저작물은 <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">크리에이티브 커먼즈 저작자표시 4.0 국제 라이선스</a>에 따라 이용할 수 있습니다.

docs/en/coc/a_intent_and_purpose.md

@@ -1,35 +1,35 @@
-# Intent and Purpose
-
-## PyCon Korea Embraces All Participants
-
-The PyCon Korea Code of Conduct (hereinafter referred to as "Code of Conduct") is the minimum commitment that members must adhere to in order to create a Python community where no one is excluded.
-
-**PyCon Korea:** 
-
-- Aims to host an event where anyone can comfortably participate.
-- Strives to create an atmosphere of recognizing and respecting differences.
-- Encourages a welcoming environment.
-
-## Why Is It Important to Embrace All Participants?
-
-PyCon Korea believes that an attitude of respecting diversity is the foundation that enriches both society and the community. Solving difficult problems and continuing to grow as a community to bring about positive changes in the world requires diverse experiences and perspectives. These experiences and perspectives come from respecting and embracing a variety of people.
-
-## PyCon Korea Does Not Tolerate Discrimination or Harassment
-
-In accordance with the Code of Conduct, the PyCon Korea Organizing Committee will:
-
-- Mediate or take disciplinary action if a situation arises where the safety or respect of another participant is compromised.
-- Expel participants who violate the Code of Conduct from event spaces (event venue, official SNS, event Slack, etc.), and in such cases, the registration fee will not be refunded.
-- Report to legal or medical authorities when necessary or upon request.
-
-## The Code of Conduct Applies to All Situations Related to the Event
-
-The Code of Conduct applies to events organized by the Python User Group, as well as to all participants involved in the event and its processes.
-
-- It applies to all participants (including speakers, partners, sponsors, volunteers, and the organizing committee).
-- It applies to all channels used to contact the organizing committee, including on the day of the event.
-- It applies to all venues and processes, including presentation content, the event venue, websites, brochures, emails, social networks, meetings, and code repositories.
-
-## Please Read Carefully
-
+# Intent and Purpose
+
+## PyCon Korea Embraces All Participants
+
+The PyCon Korea Code of Conduct (hereinafter referred to as "Code of Conduct") is the minimum commitment that members must adhere to in order to create a Python community where no one is excluded.
+
+**PyCon Korea:** 
+
+- Aims to host an event where anyone can comfortably participate.
+- Strives to create an atmosphere of recognizing and respecting differences.
+- Encourages a welcoming environment.
+
+## Why Is It Important to Embrace All Participants?
+
+PyCon Korea believes that an attitude of respecting diversity is the foundation that enriches both society and the community. Solving difficult problems and continuing to grow as a community to bring about positive changes in the world requires diverse experiences and perspectives. These experiences and perspectives come from respecting and embracing a variety of people.
+
+## PyCon Korea Does Not Tolerate Discrimination or Harassment
+
+In accordance with the Code of Conduct, the PyCon Korea Organizing Committee will:
+
+- Mediate or take disciplinary action if a situation arises where the safety or respect of another participant is compromised.
+- Expel participants who violate the Code of Conduct from event spaces (event venue, official SNS, event Slack, etc.), and in such cases, the registration fee will not be refunded.
+- Report to legal or medical authorities when necessary or upon request.
+
+## The Code of Conduct Applies to All Situations Related to the Event
+
+The Code of Conduct applies to events organized by the Python User Group, as well as to all participants involved in the event and its processes.
+
+- It applies to all participants (including speakers, partners, sponsors, volunteers, and the organizing committee).
+- It applies to all channels used to contact the organizing committee, including on the day of the event.
+- It applies to all venues and processes, including presentation content, the event venue, websites, brochures, emails, social networks, meetings, and code repositories.
+
+## Please Read Carefully
+
 This document does not contain a complete list of prohibited behaviors. It is more important to understand the intent behind this Code of Conduct and use it as a guide to treating each other better. We ask that you follow the spirit of this Code of Conduct rather than adhering strictly to its literal wording.