실행할 수 있는 절차서(LC4RI)라는 것을 아십니까?

문서와 명령이 섞여 쓰여져 있으며 명령 부분을 실행할 수 있습니다.
그 실행 결과가 실려 있습니다.
그래서 절차서로 읽고 실행한 내용과 그 때의 출력을 근거로 취할 수 있는 것으로
운영자에게는 Excel 절차를 대체하는 데 적합합니다.

그러한 쓰는 방법을 할 수 있는 툴로서 jupyter notebook이 잘 사용되고 있습니다만,
이것이 운용해 보면 문서의 정렬이라든지, 편집이 의외로 번거롭거나 한다.

더 보통의 에디터로 쓸 수 있으면··그렇게 생각하고 있었습니다. 그러면 힐라 버렸다!

VSCode의 markdown 편집 기능을 실행할 수 있도록 하면 좋다! !

만들어 보았습니다.

VScode 마켓플레이스에서 설치하는 경우 여기

이쪽 Git.

사용하는 방법

기본은 평범한 markdown과 같은 쓰기입니다. 목록과 수평선과 번호 목록에서 변경됩니다.

VSCode 커서 위치에서 아래의 명령을 실행합니다.
그래서 실행하고 싶은 부분까지 커서를 가지고 이 확장 기능을 움직여 주세요.
(단축키에 확장 기능의 실행을 할당하면 매우 편리합니다!)

목록

실행할 명령을 작성합니다.
탭에서 들여쓰기를 이동하면 AND 조건이 됩니다.
즉,

- ls existsfile.txt

- rm existsfile.txt

에서 existsfile.txt가 없으면 삭제하지 않는 것처럼 쓸 수 있습니다.

수평선

명령 실행 범위를 구분합니다. 구분하지 않으면 목록 표기를 위에서 순서대로 실행합니다.

번호 목록

변수가 있습니다. 1.~9.의 범위에서 실행 결과의 출력을 변수로서 저장합니다.
무거운 명령이나 여러 번 실행하고 싶지 않은 것은 결과를 저장하고 사용하게합니다.

후기

VSCode의 에코시스템을 사용할 수 있으므로 문장 교정이나 다른 확장 기능의 혜택도 받을 수 있군요!
이것으로 운용 작업 문서도 보기 좋고, 사용하기 쉬워질 것이라고 생각합니다.