How to Deploy Mkdocs to Coolify with Gitea

 

Mkdocs 를 기술문서로 남겨보기 위해서 찾았습니다.

github page를 이용해서 배포 하는 방법도 있는데 이왕이면 있는거 활용하고자 coolify with gitea 를 이용합니다. 

 

 

MkDocs란?

MkDocs는 개발자나 기술 문서를 작성하려는 사람들을 위해 만들어진 정적(static) 웹사이트 생성기입니다.
특히 Markdown 파일만으로도 깔끔하고 전문적인 문서 웹사이트를 빠르게 만들 수 있습니다.

---

주요 특징

• Markdown 기반
  간단한 문법으로 문서를 작성할 수 있으며, 별도의 HTML/CSS 지식이 없어도 됩니다.
• 정적 사이트 생성기
  MkDocs는 작성한 문서를 HTML 형태로 변환하여 정적인 웹사이트를 생성합니다. 데이터베이스나 서버 구성 없이 배포가 가능합니다.
• Material 테마 지원
  mkdocs-material 플러그인을 사용하면 현대적인 UI 디자인을 적용할 수 있습니다.
• Git과의 연동이 뛰어남
  Git 저장소와 함께 사용하면 버전 관리가 용이하며, 협업 및 자동 배포에도 적합합니다.

---

사용 예시

• 오픈소스 프로젝트의 개발자 문서
• 사내 기술 위키 또는 매뉴얼 사이트
• 기술 블로그 또는 튜토리얼 문서
• Flutter, React, Python 등의 기술 스택 정리 문서

---

작동 방식

1. mkdocs.yml 파일로 사이트 설정을 정의합니다.
2. docs/ 디렉토리에 Markdown 문서를 작성합니다.
3. mkdocs build 명령으로 HTML 파일을 생성합니다.
4. site/ 폴더 내의 HTML 정적 파일을 웹서버(GitHub Pages, Nginx, Coolify 등)를 통해 배포합니다.

---

기술 정보 요약

항목설명

개발 언어	Python
문서 포맷	Markdown
설치 명령어	pip install mkdocs
대표 테마	Material for MkDocs
지원 배포 방식	GitHub Pages, Coolify, Netlify, Cloudflare 등

---

MkDocs는 간단한 설정만으로도 강력한 문서 사이트를 만들 수 있어, 개인부터 팀, 기업까지 폭넓게 활용할 수 있는 문서화 도구입니다.

 

 

보다 자세한 내용은 아래의 링크에서 확인가능합니다. 

 

https://stackinfo.kage2kapp.org/how-to-deploy-mkdocs-to-coolify-with-gitea/

How to Deploy MkDocs to Coolify with Gitea