mkdocs

MkDocs

Markdown을 사용한 프로젝트 문서화

MkDocs는 프로젝트 문서 작성에 적합한 빠르고 간단 하며 정말 멋진 정적 사이트 생성기입니다. 문서 소스 파일은 Markdown으로 작성되고 단일 YAML 구성 파일로 구성됩니다. 사용하기 쉽게 설계되었으며 타사 테마, 플러그인 및 Markdown 확장으로 확장할 수 있습니다.

소개 튜토리얼과 전체 사용자 가이드는 문서를 참조하세요.

특징

• Markdown 파일에서 정적 HTML 파일을 빌드합니다.
• MkDocs를 향상하려면 플러그인과 Markdown 확장을 사용하세요.
• 내장 테마, 타사 테마를 사용하거나 자신만의 테마를 만드세요.
• 정적 파일이 제공될 수 있는 모든 곳에 문서를 게시하세요.
• 훨씬 더!

지원하다

MkDocs에 대한 도움이 필요하다면 주저하지 말고 저희에게 연락하세요!

• 질문과 높은 수준의 토론이 필요하면 GitHub의 토론을 사용하세요.
  • 작은 질문의 경우 좋은 대안은 Gitter/Matrix의 채팅방 입니다.
• 버그를 보고하거나 기능을 요청하려면 GitHub에서 문제를 엽니다.

MkDocs의 핵심 기능과 관련된 문제/질문에 대해서만 지원을 제공할 수 있습니다. 타사 테마, 플러그인, 확장 기능 또는 이와 유사한 기능에 대한 질문이나 버그 보고서는 해당 프로젝트에 제출해야 합니다.
하지만 이런 질문은 채팅방에서 금지되지 않습니다 .

몇 가지 질문에 답하기 위해 계속 머무르십시오!

모래밭

• 공식 문서
• 최신 릴리스 노트
• 타사 플러그인, 테마 및 레시피 카탈로그

MkDocs에 기여

MkDocs 프로젝트는 오픈 소스 커뮤니티의 개발자와 사용자의 기여를 환영하고 이에 의존합니다. 도움을 줄 수 있는 방법에 대한 정보는 기여 가이드를 참조하세요.

행동 강령

MkDocs 프로젝트의 코드베이스, 이슈 추적기 및 토론 포럼에서 상호 작용하는 모든 사람은 PyPA 행동 강령을 따라야 합니다.

특허

BSD-2-절