docs(chore): 사이트 꾸미기 (#693)

* docs: 폴더로 정렬 * docs(chore): 사이트 꾸미기
jiphyeonjeon-42 · Aug 24, 2023 · 8715139 · 8715139
1 parent 7c57107
commit 8715139
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 4 deletions.
diff --git a/docs/docs/convention.md → docs/docs/convention/convention.md b/docs/docs/convention.md → docs/docs/convention/convention.md
diff --git a/docs/docs/gitflow.md → docs/docs/convention/gitflow.md b/docs/docs/gitflow.md → docs/docs/convention/gitflow.md
diff --git a/docs/docs/issue_strategy.md → docs/docs/convention/issue_strategy.md b/docs/docs/issue_strategy.md → docs/docs/convention/issue_strategy.md
@@ -8,6 +8,6 @@
 
 [참고: 415 이슈](https://github.com/jiphyeonjeon-42/backend/issues/415)
 
-## [우산 이슈 ☂️](./convention/umbrella.md)
+## [우산 이슈 ☂️](./umbrella.md)
 
 장기간 (~1주일) 진행되는 이슈는 우산 이슈를 이용해 태스크리스트 형태로 관리합니다.
diff --git a/docs/docs/umbrella.md → docs/docs/convention/umbrella.md b/docs/docs/umbrella.md → docs/docs/convention/umbrella.md
diff --git a/docs/docs/image/favicon.png b/docs/docs/image/favicon.png
diff --git a/docs/docs/image/logo.png b/docs/docs/image/logo.png
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -1,5 +1,7 @@
 # 집현전 개발 가이드에 오신 것을 환영합니다
 
-## [프로젝트 실행하기](./setup.md)
+## [프로젝트 실행하기](./tutorials/setup.md)
+
 ## [프로젝트 개요](./explanation.md)
 
+## [튜토리얼](./tutorials/contract.md)
diff --git a/docs/docs/guides/contract.md → docs/docs/tutorials/contract.md b/docs/docs/guides/contract.md → docs/docs/tutorials/contract.md
diff --git a/docs/docs/usage.md → docs/docs/tutorials/mkdocs.md b/docs/docs/usage.md → docs/docs/tutorials/mkdocs.md
@@ -1,4 +1,4 @@
-# How to use Mkdocs
+# Mkdocs로 개발 문서 작성하기
 ### 로컬에서 정적 페이지 빌드
 1. working directory의 루트 디렉토리에 docs/ 생성
 2. mkdocs 설치 (mkdocs 공식문서 참조)
@@ -16,4 +16,4 @@
 앞에서 알아본 배포법은 직접 빌드하고 배포까지 해야 한다. 매우 귀찮음.
 github action 을 통해 특정 트리거가 발생하면 자동으로 빌드 - 배포를 하도록 만들 수 있음.
 이를 위해서는 .github/workflows/ 디렉토리에 .yml 파일 작성 ( github action 을 작동시킬 파일 ) 해야한다.
-yml 의 예시는.. 디렉토리 참조.
+yml 의 예시는.. 디렉토리 참조.
diff --git a/docs/docs/setup.md → docs/docs/tutorials/setup.md b/docs/docs/setup.md → docs/docs/tutorials/setup.md
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -1,9 +1,30 @@
 site_name: 집현전 개발 가이드
+
+repo_name: jiphyeonjeon-42/backend
+repo_url: https://github.com/jiphyeonjeon-42/backend
+edit_uri: edit/develop/docs/
+
 theme:
   name: material
   language: ko
+  palette:
+    primary: black
+  logo: image/logo.png
+  favicon: image/favicon.png
+  icon:
+    repo: fontawesome/brands/github
+    edit: material/pencil
+    view: material/eye
+  features:
+    - header.autohide
+    - navigation.sections
+    - navigation.footer
+    - content.action.edit
+    - content.action.view
+
 
 extra:
+  generator: false
   static_dirs:
     - docs/image