#114 Add kit tools (#115)

choisungwook · Dec 12, 2024 · 4f8ef5a · 4f8ef5a
1 parent 76dc46e
commit 4f8ef5a
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 6 deletions.
diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml
@@ -6,7 +6,6 @@ on:
       - 'mkdocs/**'
     branches:
     - master
-    - main
 
 permissions:
   contents: write

diff --git a/mkdocs/README.md b/mkdocs/README.md
@@ -3,12 +3,16 @@ mkdocs
 
 # 로컬 실행방법
 
-```bash
-$ pip install poetry
-$ poetry shell
-$ poetry install
-$ http://127.0.0.1:8000 접속
+* mkdocs 실행
+
+```sh
+pip install poetry
+poetry shell
+poetry install
+mkdocs serve
 ```
 
+* 웹 브라우저 접속: http://127.0.0.1:8000로 접속
+
 # 참고자료
 * https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
diff --git a/mkdocs/docs/tools b/mkdocs/docs/tools
@@ -0,0 +1 @@
+../../tools/
diff --git a/tools/README.md b/tools/README.md
@@ -0,0 +1,5 @@
+## 개요
+* 내가 사용하는 도구 목록
+
+## 목록
+* [kit](./kit.md)
diff --git a/tools/kit.md b/tools/kit.md
@@ -0,0 +1,10 @@
+## 개요
+* 로컬에서 쉽게 실행할 수 있는 DAG 도구로서, makefile을 DAG로 구성할 때 사용
+* github: https://github.com/kitproj/kit
+
+## 설치 방법
+
+```sh
+brew tap kitproj/kit --custom-remote https://github.com/kitproj/kit
+brew install kit
+```