- 문서 속 코드 스니펫을 실제로 실행 가능하게 만들어, runbook·운영 문서·README의 유용성/신뢰성을 높이기 위해 개발
- 마크다운의 코드 블록을 그대로 실행해 문서를 단계별로 쉽게 따라하며 검증 가능
- 명령어를 실행하고, 중간 결과를 확인하고, 원하는 출력이 달성되었는지 확인
- Shell/Bash, Python, JavaScript/TypeScript, Ruby 등 다양한 런타임을 shebang 기반으로 지원
- 코드 셀 실행 시 환경 변수와 실행 컨텍스트를 유지해, 터미널 세션처럼 단계별 실행 가능
- 이전 셀의 출력 결과를 다음 셀로 전달하는 파이프라인형 실행 흐름도 지원
- Makefile, npm scripts, Gradle, Deno task 등 기존 태스크 정의와 완전 호환됨
-
run, list, print 명령을 통해 문서 내 실행 가능한 워크플로를 탐색·실행·검증 가능
- 운영 문서의 bitrot 문제를 줄이고, 단계별 실행이 필요한 실무 문서에 특히 적합
-
bitrot : 문서나 코드가 시간이 지나면서 실제 환경과 어긋나 점점 신뢰를 잃는 현상
- Homebrew, npm, Go install, 단일 바이너리 등으로 설치 가능
- Apache 2.0 라이선스