나의 위키
공부한 것, 업무 매뉴얼, 환경 셋업 기록을 한곳에 모아 둔다. 마크다운 파일만 추가하면 사이드바·검색·태그·최근 목록이 알아서 따라온다.
문서 추가하기
터미널에서 아래 명령 하나로 시작한다. VS Code라면 명령 팔레트에서 Tasks: Run Task → 위키: 새 문서를 골라도 된다.
bash
npm run new카테고리를 고르고(없으면 그 자리에서 만들고), 템플릿을 고르고, 제목을 넣으면 끝이다.
📝 새 위키 문서 만들기
어느 카테고리에 넣을까요?
1. 개발 학습 노트 (dev/)
2. + 새 카테고리 만들기
번호 선택 (1-2): 1
어떤 템플릿으로 시작할까요?
1. 학습 노트 배운 것 / 개념 / 코드 예제 / 헷갈렸던 점
2. 매뉴얼 · 절차서 목적 / 사전 준비 / 절차 / 확인 방법
3. 셋업 가이드 환경 / 설치 / 설정 / 검증 / 트러블슈팅
번호 선택 (1-3): 1
문서 제목: VitePress 데이터 로더
파일명 (엔터 = vitepress): vitepress-data-loader
✔ 문서 생성: docs/dev/vitepress-data-loader.md템플릿 3종
| 템플릿 | 언제 쓰나 | 뼈대 |
|---|---|---|
| 학습 노트 | 새로 공부한 기술을 정리할 때 | 배운 것 · 핵심 개념 · 코드 예제 · 헷갈렸던 점 · 참고 링크 |
| 매뉴얼 · 절차서 | 남(또는 미래의 나)이 그대로 따라 해야 할 때 | 목적·대상 · 사전 준비 · 절차 · 확인 방법 · 문제 발생 시 |
| 셋업 가이드 | 설치·환경 구축 과정을 남길 때 | 환경 정보 · 설치 · 설정 · 검증 · 트러블슈팅 |
템플릿은 카테고리에 묶여 있지 않다. 어느 카테고리에서든 셋 중 원하는 걸 고르면 된다.
카테고리는 미리 만들지 않는다
docs/ 아래 폴더 하나가 카테고리 하나다. npm run new에서 + 새 카테고리 만들기 를 고르면 폴더와 index.md가 함께 만들어지고, 그 순간부터 아래 카드와 왼쪽 사이드바에 자동으로 나타난다.
frontmatter
문서 맨 위 --- 블록이 모든 자동화의 입력값이다.
yaml
---
title: 문서 제목 # 사이드바·검색에 표시 (없으면 첫 # 헤딩)
description: 한 줄 요약 # 태그·최근 목록의 부연 설명
tags: [vitepress, 셋업] # /tags 페이지에 모임
created: 2026-07-24
updated: 2026-07-24 # 비우면 git 커밋 시각을 대신 씀
status: draft # draft | wip | done
order: 10 # (선택) 작을수록 사이드바 위쪽
---카테고리의 index.md는 두 필드를 더 쓴다.
icon— 아래 카드에 표시할 이모지hidden: true— 카드와 사이드바에서 통째로 숨김 (아직 정리 중인 카테고리에 유용)
이미지 넣기
스크린샷을 클립보드에 담고 붙여넣기 단축키를 누르면 docs/public/images/<문서이름>/ 에 저장되고 링크까지 삽입된다. 직접 넣을 때도 docs/public/ 아래에 두고 /images/foo.png 처럼 참조하면 된다.
다이어그램
코드 블록 언어를 mermaid 로 쓰면 그대로 그려진다.
md
```mermaid
flowchart LR
A[초안] --> B[정리] --> C[공개]
```배포
main 브랜치에 push하면 GitHub Actions가 빌드해서 GitHub Pages에 올린다. 따로 할 일은 없다.
bash
git add . && git commit -m "문서 추가" && git push카테고리
아직 카테고리가 없습니다.
터미널에서
터미널에서
npm run new 를 실행해 첫 문서를 만들어 보세요. 카테고리를 만들면 여기와 사이드바에 자동으로 나타납니다.