MkDocs

MkDocs
MkDocs
개발자톰 크리스티, 더걸 매튜스, 웨일런 림버그, 올레 프라이핀, 울트라버그
최초출시2014년 1월 24일 (2014-01-24)
안정적인 방출
1.5.3[1] / 2023년 9월 18일, 2개월(2023-09-18)
저장소
작성자파이썬
운영체제크로스 플랫폼
유형문서 생성기
면허증.BSD
웹사이트www.mkdocs.org

MkDocs건물 프로젝트 문서화를 위해 설계된 정적 사이트 생성기입니다. 파이썬으로 작성되며, 다른 환경에서도 사용됩니다.

작동모드

MkDocs는 Markdown 파일을 HTML 페이지로 변환하여 문서를 포함하는 정적 웹 사이트를 효과적으로 만듭니다.

마크다운은 확장 가능하며, MkDocs 생태계는 소스 코드에서 문서를 자동 생성하고, 경고를 추가하고, 수학적 표기법을 작성하고, 각주를 삽입하고, 소스 코드를 강조하는 등을 돕는 여러 확장[2][3] 기능을 통해 확장 가능한 특성을 활용합니다.

테마

MkDodcs는 기본 테마(부트스트랩 기준)와 Read the Docs 테마의 두 가지 내장 테마를 제공합니다. 인기 있는 MkDocs용 자료 테마를 [4]포함하여 사용 가능한 타사 테마 중 많은 것이 공식 카탈로그에 나열되어 있습니다.[5]

역사

MkDocs의 첫 번째 태그 버전인 버전 0.2는 2014년 1월 21일에 출시되었습니다.[6]

2015년 초까지 Read the Docs스핑크스 외에도 MkDocs와 함께 빌딩 문서를 지원했습니다. 0.12 릴리스를 [7]준비하기 위해 MkDocs는 호스팅을 위해 Read the Docs를 사용하기 시작했습니다.[8]

2016년 1월, MkDocs는 설치 가능한 테마에 대한 지원을 추가했습니다.[9] 다음 달, Martin Donath는 MkDocs 테마를 위한 Material 개발을 시작했습니다. 다음 해에 이 테마는 큰 인기를 끌었고 2020년 7월에 개발 모델이 스폰서웨어로 변경되었으며 새로운 기능이 먼저 내부자 버전으로 출시되고 펀딩 목표가 달성된 후 공개적으로 사용할 수[10] 있게 되었습니다.

참고 항목

참고문헌

  1. ^ "Release Notes". MkDocs.
  2. ^ "Extensions — Python-Markdown 3.4.4 documentation". python-markdown.github.io. Retrieved 2023-09-23.
  3. ^ "Pymdown Extensions - PyMdown Extensions Documentation". facelessuser.github.io. Retrieved 2023-09-23.
  4. ^ Theming catalog, MkDocs, 2023-09-23, retrieved 2023-09-23
  5. ^ Donath, Martin. "Material for MkDocs". squidfunk.github.io. Retrieved 2023-09-23.
  6. ^ "Release 0.2 · mkdocs/mkdocs". GitHub. Retrieved 2023-09-24.
  7. ^ "MkDocs 0.12 is in the wild. Lots of bug fixes and a few new features". X (formerly Twitter). 2015-04-14. Retrieved 2023-09-24.
  8. ^ "mkdocs Read the Docs". readthedocs.org. 2015-02-12. Retrieved 2023-09-24.
  9. ^ "The new MkDocs release supports installable themes. Nice addition to the project that will let you install via pip". X (formerly Twitter). 2016-01-21. Retrieved 2023-09-24.
  10. ^ Donath, Martin (2021-12-27). "The past, present and future - Material for MkDocs". squidfunk.github.io. Retrieved 2023-09-24.

외부 링크

  • MkDocs Edit this at Wikidata
  • Sphinx, MkDocs 및 Jupyter Book을 기반으로 하는 Docs 대규모 협업 문서 호스트 읽기