adamchainz/blacken-docs

어떤 프로젝트인가요?

핵심 기능

• 01Markdown 및 reStructuredText 파일의 python과 pycon 블록을 서식 지정합니다
• 02LaTeX 문서의 minted 및 PythonTeX 코드 블록을 처리합니다
• 03Python docstring 내부의 Markdown 및 reST 코드 예제를 다시 서식 지정합니다
• 04--check 모드를 제공하며 파일이 변경되면 0이 아닌 종료 코드를 반환합니다
• 05Black 버전을 고정해 사용할 수 있는 pre-commit hook으로 제공됩니다

활용 사례

• 프로젝트의 README나 Markdown 문서에 있는 Python 스니펫의 서식을 일관되게 유지하기
• Sphinx 기반 reStructuredText 문서의 코드 예제 서식 준수 여부를 확인하기
• 변경 사항을 병합하기 전에 CI나 pre-commit에서 문서 서식 검사를 실행하기

빠른 시작

1. 1

   pip으로 blacken-docs를 설치하세요

   python -m pip install blacken-docs
2. 2

   문서 파일에 blacken-docs를 실행하세요

   blacken-docs README.rst

사용 전 알아둘 점

• !Markdown, reStructuredText, LaTeX 파일 내의 Python 코드 블록만 포맷합니다.
• !디렉터리를 재귀적으로 처리하지 않습니다. 파일 이름을 직접 지정하거나 glob 패턴 또는 pre-commit을 사용해야 합니다.

포함된 컬렉션

토픽

자주 묻는 질문

blacken-docs은(는) 무엇인가요?

Markdown, reStructuredText, LaTeX 문서 파일에 포함된 Python 코드 블록에 Black을 실행하는 CLI 도구입니다. blacken-docs는 문서에 삽입된 Python 코드 예제를 프로젝트의 다른 코드와 같은 형식으로 정리합니다. Markdown과 reStructuredText의 python 및 pycon 블록, LaTeX의 minted 및 PythonTeX 블록, 그리고 Python docstring 내부의 Markdown이나 reST를 처리합니다.

blacken-docs은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

blacken-docs은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

blacken-docs은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. blacken-docs의 마지막 커밋은 2026년 11월 4일입니다.

blacken-docs은(는) 어디에 사용할 수 있나요?

프로젝트의 README나 Markdown 문서에 있는 Python 스니펫의 서식을 일관되게 유지하기 Sphinx 기반 reStructuredText 문서의 코드 예제 서식 준수 여부를 확인하기 변경 사항을 병합하기 전에 CI나 pre-commit에서 문서 서식 검사를 실행하기

blacken-docs는 어떻게 설치하나요?

pip으로 blacken-docs를 설치하세요: python -m pip install blacken-docs 문서 파일에 blacken-docs를 실행하세요: blacken-docs README.rst

blacken-docs은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/adamchainz/blacken-docs