본문으로 건너뛰기
50% 할인 모든 플랜, 기간 한정. 시작 가격 $2.48/mo
MkDocs

MkDocs

MkDocs는 YAML 설정 파일 하나로 마크다운 폴더를 문서 사이트로 바꿔 줍니다. 라이브 리로드 개발 서버를 제공하고, 어디에나 올릴 수 있는 순수 정적 HTML을 만들어 냅니다. BSD-2-Clause 라이선스, GitHub 스타 22,300개 이상.

한눈에 보기

22.4k

GitHub 스타

1

페이지 조회수

라이선스 BSD-2-Clause 버전 Latest OS Ubuntu Server 24.04 LTS Min RAM 1 GB IP IPV4,IPV6

접속

  • 열기: http://SERVER_IP

콘텐츠 편집 및 게시

1. 마크다운 파일을 추가하거나 편집합니다: /opt/mkdocs/docs

2. 페이지를 추가하거나 이름을 바꾸면 다음을 업데이트하세요: /opt/mkdocs/mkdocs.yml for navigation.

3. 사이트를 다시 빌드합니다:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

Nginx는 생성된 파일을 다음 위치에서 제공합니다: /opt/mkdocs/site

다시 빌드한 뒤 Nginx를 재시작할 필요는 없습니다.

중요한 경로

  • 프로젝트: /opt/mkdocs
  • 콘텐츠: /opt/mkdocs/docs
  • 설정: /opt/mkdocs/mkdocs.yml
  • 빌드 결과물: /opt/mkdocs/site
  • Python 가상 환경: /opt/mkdocs/venv
  • MkDocs 실행 파일: /opt/mkdocs/venv/bin/mkdocs
  • Nginx 구성: /etc/nginx/sites-available/mkdocs.conf

도메인 및 HTTPS

1. 도메인을 서버 IP 주소로 지정합니다.

2. Nginx 설정을 편집하고 다음을 바꿉니다: server_name _; 을 자신의 도메인으로 바꿉니다(예: server_name <YOUR_DOMAIN>;):

vim /etc/nginx/sites-available/mkdocs.conf

3. 구성을 테스트합니다:

nginx -t

4. Certbot을 설치합니다:

apt install -y certbot python3-certbot-nginx

5. Let's Encrypt 인증서를 생성합니다:

certbot --nginx --non-interactive --agree-tos --email <YOUR_EMAIL> -d <YOUR_DOMAIN>

6. Nginx를 다시 로드합니다:

systemctl reload nginx

7. MkDocs 사이트 URL을 업데이트합니다: 다음을 바꿉니다 site_url: 'http://<SERVER_IP>/' 을 다음으로: site_url: 'https://<YOUR_DOMAIN>/' in /opt/mkdocs/mkdocs.yml.

8. 사이트를 다시 빌드합니다:

/opt/mkdocs/venv/bin/mkdocs build --clean \
  --config-file /opt/mkdocs/mkdocs.yml \
  --site-dir /opt/mkdocs/site

9. 브라우저를 열고 방문: https://<YOUR_DOMAIN>

참고

  • 마크다운 변경은 다시 빌드해야 공개 사이트에 반영됩니다.
  • Nginx serves the generated files from /opt/mkdocs/site.
  • 변경 mkdocs.yml 와 프로젝트 구성을 원하는 대로 변경하세요.

개발 도구의 더 보기

관련 앱.

지금 MkDocs를 배포하세요. 월 $2.48부터.