danielfrg/mkdocs-jupyter

어떤 프로젝트인가요?

핵심 기능

• 01.ipynb 및 Jupytext .py 파일을 MkDocs 내비게이션에 바로 추가합니다.
• 02변환 전에 노트북을 선택적으로 실행하며, 파일별로 실행을 제외할 수 있습니다.
• 03전역으로 또는 태그가 지정된 셀에서 코드 입력이나 프롬프트를 숨깁니다.
• 04Jupyter 테마, ipywidgets, MathJax 수식 렌더링을 지원합니다.
• 05노트북 소스 다운로드 링크를 제공하고 변환 결과를 캐시합니다.

활용 사례

• 문서 사이트에서 실행 가능한 코드와 출력이 포함된 데이터 과학 튜토리얼을 게시합니다.
• 실행 가능한 예제가 포함된 API 또는 라이브러리 문서를 만듭니다.
• MkDocs에서 노트북 형식으로 기술 블로그 글이나 강의 자료를 작성합니다.

빠른 시작

1. 1

   PyPI에서 플러그인을 설치합니다

   pip install mkdocs-jupyter
2. 2

   mkdocs.yml의 plugins에 플러그인을 추가하고 nav에 노트북이나 .py 파일을 나열합니다

사용 전 알아둘 점

• !MkDocs 플러그인으로만 작동하므로 기존 MkDocs 사이트가 필요합니다.

포함된 컬렉션

토픽

자주 묻는 질문

mkdocs-jupyter은(는) 무엇인가요?

Jupyter Notebook과 Jupytext .py 파일을 문서 페이지로 변환하고, 선택적으로 실행 및 테마 스타일을 적용하는 MkDocs 플러그인입니다. mkdocs-jupyter를 사용하면 Jupyter Notebook을 MkDocs 사이트의 내비게이션에 바로 추가할 수 있어 튜토리얼과 분석 글을 일반 Markdown 페이지와 함께 배치할 수 있습니다. .ipynb 파일뿐 아니라 Jupytext 형식의 Python 스크립트도 지원하며, Jupyter 테마와 ipywidgets를 지원하면서 표준 Jupyter Notebook 출력과 같은 스타일로 렌더링합니다.

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

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

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

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

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

문서 사이트에서 실행 가능한 코드와 출력이 포함된 데이터 과학 튜토리얼을 게시합니다. 실행 가능한 예제가 포함된 API 또는 라이브러리 문서를 만듭니다. MkDocs에서 노트북 형식으로 기술 블로그 글이나 강의 자료를 작성합니다.

mkdocs-jupyter는 어떻게 설치하나요?

PyPI에서 플러그인을 설치합니다: pip install mkdocs-jupyter mkdocs.yml의 plugins에 플러그인을 추가하고 nav에 노트북이나 .py 파일을 나열합니다

mkdocs-jupyter은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/danielfrg/mkdocs-jupyter