Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Aug 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@

[참고: 415 이슈](https://github.com/jiphyeonjeon-42/backend/issues/415)

## [우산 이슈 ☂️](./convention/umbrella.md)
## [우산 이슈 ☂️](./umbrella.md)

장기간 (~1주일) 진행되는 이슈는 우산 이슈를 이용해 태스크리스트 형태로 관리합니다.
File renamed without changes.
Binary file added docs/docs/image/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/image/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 집현전 개발 가이드에 오신 것을 환영합니다

## [프로젝트 실행하기](./setup.md)
## [프로젝트 실행하기](./tutorials/setup.md)

## [프로젝트 개요](./explanation.md)

## [튜토리얼](./tutorials/contract.md)
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/docs/usage.md → docs/docs/tutorials/mkdocs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to use Mkdocs
# Mkdocs로 개발 문서 작성하기
### 로컬에서 정적 페이지 빌드
1. working directory의 루트 디렉토리에 docs/ 생성
2. mkdocs 설치 (mkdocs 공식문서 참조)
Expand All @@ -16,4 +16,4 @@
앞에서 알아본 배포법은 직접 빌드하고 배포까지 해야 한다. 매우 귀찮음.
github action 을 통해 특정 트리거가 발생하면 자동으로 빌드 - 배포를 하도록 만들 수 있음.
이를 위해서는 .github/workflows/ 디렉토리에 .yml 파일 작성 ( github action 을 작동시킬 파일 ) 해야한다.
yml 의 예시는.. 디렉토리 참조.
yml 의 예시는.. 디렉토리 참조.
File renamed without changes.
21 changes: 21 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

Expand Down