Skip to content

Wiki 사용방법 안내

박태영 edited this page Aug 16, 2024 · 1 revision

📢 이 Wiki는요

레포에 공식 Docs로 커밋하기는 애매한데,
혹은 각주와 이슈댓글란에 적기에는 또 너무 구구절절한데,
"어? 이 부분은 왜 이렇게 되어있지?"할만한 것들을 모으고 싶어요.

📏 문서 제목을 이렇게 해볼까요?

  • 제목: [관련된 이슈 번호] 컨텐츠 내용
    (ex: [#7] Admin page 방향성 블로그 글, [*] 앱 전체 구조/플로우 파악 공유)
  • 내용은 자유롭게 기술

🗂️ 목차는요

오른쪽 문서목록을 봐주세요.

❓ Wiki 작성방법 가이드

마크다운 문법에 익숙하지 않다면?

이 링크를 참조! github| ihoneymon/how-to-write-by-markdown.md

웹브라우저에서 바로 작성하기가 영 불편하다면?

로컬에서는 Typora, VScode 편집기를 추천드리고,
혹은 notion으로 작성한 다음 마크다운으로 추출해도 됩니다.

다른 레포에서 작성한 위키를 옮기고 싶다면?

다른 레포지토리에서 작성한 위키는 아래 방법으로 옮길 수 있대요.

# 레포지토리의 위키를 클론하고 
git clone --mirror https://github.com/your-namespace/your-project.wiki.git
# 해당 디렉토리로 이동한 다음
cd your-project
# 푸시해주면 됩니다
git push --mirror https://github.com/your-namespace/your-project.wiki.git