[Rust] mdbook으로 예쁜 문서 만들기
mdbook은 rust에서 제공하는 마크다운 기반 문서화 도구다.
rust로 만들어진건 맞는데, 마크다운 기반 생성기라서 rust를 몰라도 쓸 수 있다.
이런 문서가 다 그걸로 만든 것이다.
설치
이걸 만들려면 먼저 전용 cli를 설치해야 한다.
cargo install mdbook
그래서 이렇게 실행되면 된 것이다.
프로젝트 구성
먼저 init 명령으로 프로젝트를 구성한다.
mdbook init 폴더명
그럼 이런식으로
던져준다.
저 src 디렉토리 안에 들어가는 마크다운들이 문서화의 대상이 되는 것이다.
실행하기
그대로 명령을 실행하면 바로 페이지가 뜬다.
mdbook serve --open
이렇게 말이다.
이 상태에서는 저장만 해도 즉시 반영해서 페이지를 리로드한다.
예쁘게 잘 나온다.
마크다운 표현법에 대해서 상세히 알고 싶다면 문서를 참조하는 편이 좋겠다.
https://rust-lang.github.io/mdBook/format/index.html
게시하기
결과물을 별도로 배포하는건 아주 쉽다.
애초에 정적 페이지로 생성하는 거라서, build나 serve 명령을 실행한 이후에
book 디렉터리 안에 생성된 것을 그대로 서빙하면 되는 것이다.
