아마도 The Ultimate Technical Documentation Guide일 것입니다.

### 참고 - 기사 작성을 시작하므로 모든 피드백에 감사드립니다.

소개

기술 문서 관리는 Haaaard입니다. 누구나 그것을 쓰겠지만 아무도 그것을 유지하지 않을 것입니다. Confluence, Readme, Gitbook, Read the Docs 등은 모두 훌륭한 목적을 가지고 있지만 시스템 및 부서에 대한 최신 문서를 정말로 원한다면 바로 시작하겠습니다!

If you haven't got time to read then you can view the results here

Or, if you just want to source code with tutorial visit the github repo

이게 뭐야?

도커 + Mkdocs + Mkdocs 플러그인 + draw.io + mermaid + meta

그럼 보여줘

리포지토리 설치

git clone [email protected]:cribmove/mkdocs-example-demo.git
cd mkdocs-example.demo
cd docs
docker compose up -d

방문 localhost:8124

좋아, 하지만 또 뭐야?

여러 저장소

https://www.npmjs.com/package/meta과 같은 도구를 사용하면 많은 리포지토리를 중앙 리포지토리로 가져올 수 있습니다. 여러 프로젝트를 관찰하고 문서를 중앙 집중화하는 데 좋습니다. 아래와 같이 외부 저장소의 mkdocs.yaml을 포함하기만 하면 됩니다.

nav:
  - External Repository: '*include ./second-repo/mkdocs.yml'

그리기 io 통합

VSCode draw.io extension 을 사용하여 코드 편집기에서 다이어그램을 작성하고 MKdocs에서 볼 수 있습니다!

인어 다이어그래밍

원하는 경우 mermaid 구문을 사용하여 코드에서 다이어그램을 작성할 수 있습니다. 학습 곡선이 있지만 코드 옆에 다이어그램을 작성하는 이점이 학습 시간보다 중요합니다.

오픈 API 통합

API 사양 및 정의에 충실한 경우 로컬 정의를 문서에 게시할 수 있습니다(다중 리포지토리 및 계약에 유용함).

결론

Mkdocs는 모든 사람을 위한 것은 아니지만 개발자 요구 사항을 충족합니다. Mkdocs가 제공하는 확장성, git 히스토리 및 빠른 액세스는 진정으로 Dev 경험을 더욱 즐겁게 만들어 줄 것입니다. 빠르게 구축할 수 있을 뿐만 아니라 Github 페이지에 게시하고 클라우드 전면에 쉽게 게시하고 netlify할 수 있습니다!

한번 해보세요!