Repolode
bwplotka

bwplotka/mdox

GFM 스타일로 Markdown을 포맷하고, 명령어로 코드 스니펫을 자동 생성하며, 링크를 확인하고, Markdown에서 정적 문서 웹사이트를 빌드하는 Go CLI입니다.

스타
84
포크
12
열린 이슈
33
마지막 커밋
4일 전

어떤 프로젝트인가요?

mdox는 프로젝트 문서를 정확하고 일관되게 유지하기 위한 명령줄 도구입니다. GitHub Flavored Markdown에 맞춰 Markdown 파일을 직접 포맷하고, 상대 링크와 외부 링크를 검증할 수 있습니다. 특정 URL을 검사에서 제외하거나 GitHub API를 통해 GitHub 이슈 및 pull request 링크를 확인하는 옵션도 제공합니다.

코드 생성 기능은 mdox-exec 지시문이 표시된 펜스 코드 블록을 명령어로 실행하고 그 출력을 삽입해 다시 작성합니다. 이를 통해 CLI 도움말, 샘플 설정 파일, 소스 코드 발췌문을 설명 대상 코드와 동기화할 수 있습니다. 블록별로 0이 아닌 종료 코드를 허용하도록 지정할 수도 있습니다.

웹사이트에 사용할 때는 여러 도메인이나 버전을 지원하는 사이트에 맞게 링크를 상대 경로로 다시 작성할 수 있습니다. 또한 front matter와 back matter를 추가하고, 파일 이름을 바꾸거나 이동하며, Hugo 같은 정적 사이트 생성기에 맞게 링크를 조정하는 변환도 실행할 수 있습니다. Go 라이브러리로 사용할 수도 있습니다.

핵심 기능

  • 01Markdown 파일을 제자리에서 일관된 GFM 스타일로 포맷합니다.
  • 02CLI 도움말 출력과 같은 명령어 실행 결과로 코드 블록 내용을 자동 생성합니다.
  • 03설정 가능한 제외 규칙과 GitHub를 고려한 검증 기능으로 상대 링크와 외부 링크를 확인합니다.
  • 04여러 도메인이나 버전을 지원하는 웹사이트에 맞게 링크를 상대 경로로 다시 작성합니다.
  • 05정적 사이트 생성기에 맞춰 front matter와 back matter를 추가하고 파일을 이동하는 등 Markdown을 변환합니다.

활용 사례

  • CI를 통해 저장소 README의 CLI 도움말과 설정 예제를 최신 상태로 유지합니다.
  • pull request 검사 중 문서의 깨진 링크를 찾아냅니다.
  • Markdown 소스에서 버전별 프로젝트 문서를 정적 웹사이트로 게시합니다.

빠른 시작

  1. 1

    Go로 mdox CLI 설치하기

  2. 2

    mdox fmt로 Markdown 파일 포맷하기

    mdox fmt *.md

사용 전 알아둘 점

  • README에 명시적인 go install 명령이 없으므로 설치 단계는 명령어로 표시하지 않았습니다.
  • 이 프로젝트는 스타가 80개로 규모가 작아 커뮤니티 지원이 제한적일 수 있습니다.

포함된 컬렉션

토픽

자주 묻는 질문

mdox은(는) 무엇인가요?
GFM 스타일로 Markdown을 포맷하고, 명령어로 코드 스니펫을 자동 생성하며, 링크를 확인하고, Markdown에서 정적 문서 웹사이트를 빌드하는 Go CLI입니다. mdox는 프로젝트 문서를 정확하고 일관되게 유지하기 위한 명령줄 도구입니다. GitHub Flavored Markdown에 맞춰 Markdown 파일을 직접 포맷하고, 상대 링크와 외부 링크를 검증할 수 있습니다. 특정 URL을 검사에서 제외하거나 GitHub API를 통해 GitHub 이슈 및 pull request 링크를 확인하는 옵션도 제공합니다.
mdox은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
mdox은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
mdox은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. mdox의 마지막 커밋은 2026년 11월 3일입니다.
mdox은(는) 어디에 사용할 수 있나요?
CI를 통해 저장소 README의 CLI 도움말과 설정 예제를 최신 상태로 유지합니다. pull request 검사 중 문서의 깨진 링크를 찾아냅니다. Markdown 소스에서 버전별 프로젝트 문서를 정적 웹사이트로 게시합니다.
mdox는 어떻게 설치하나요?
Go로 mdox CLI 설치하기 mdox fmt로 Markdown 파일 포맷하기: mdox fmt *.md
mdox은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/bwplotka/mdox

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트

Markdown, HTML, 웹사이트 등에서 깨진 URL과 이메일 주소를 찾아내는 Rust 기반 고속 비동기 링크 검사기입니다.

개발 도구#link-checker#rust#broken-links
4.1천+34 이번 주246RustApache-2.0활발히 관리됨업데이트 5일 전