From 4f8ef5af89e9301d3019737478008035c92bb11c Mon Sep 17 00:00:00 2001 From: choisungwook <9348148+choisungwook@users.noreply.github.com> Date: Fri, 13 Dec 2024 08:52:51 +0900 Subject: [PATCH] #114 Add kit tools (#115) --- .github/workflows/mkdocs.yaml | 1 - mkdocs/README.md | 14 +++++++++----- mkdocs/docs/tools | 1 + tools/README.md | 5 +++++ tools/kit.md | 10 ++++++++++ 5 files changed, 25 insertions(+), 6 deletions(-) create mode 120000 mkdocs/docs/tools create mode 100644 tools/README.md create mode 100644 tools/kit.md diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml index 33d58d30..87b785a0 100644 --- 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 index 4b681b7f..c9e5a253 100644 --- 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 new file mode 120000 index 00000000..aba6f533 --- /dev/null +++ b/mkdocs/docs/tools @@ -0,0 +1 @@ +../../tools/ \ No newline at end of file diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 00000000..b5a37c56 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,5 @@ +## 개요 +* 내가 사용하는 도구 목록 + +## 목록 +* [kit](./kit.md) diff --git a/tools/kit.md b/tools/kit.md new file mode 100644 index 00000000..5fc119e7 --- /dev/null +++ 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 +```