위키와 같은 마크업언어이다. 특히 기술문서 작성에 특화된 거 같다.
나는 회사의 인터넷PC에서 문서작성이 어려워서 위키와 같은 인터넷 문서작성도구가 유용하다. 이것은 문서 작성이 끝나면 깃허브를 통해 배포할 수다.
위키에 이어 쥬피터북도 설치해 보려고 한다.
https://jupyterbook.org/en/stable/start/your-first-book.html
쥬피터북 설치
pip install -U jupyter-book
제대로 설치되었는지 확인
jupyter-book –helpFor more complete information about the CLI, see Command-line interface reference.
작업공간 생성
jupyter-book create mynewbook/
생성된 공간에서 작업 수행
작업 완료후 배포를 위해 빌드
jupyter-book build mynewbook
이후에는 변경사항만 업데이트한다. 전체를 다시 빌드하기 위해서는 jupyter-book build –all mybookname/ 와 같이 –all 옵션을 추가해야 한다.
웹에서 보기 위해 링크로 연결
ln -s ~/development/python/mynewbook/_build/html mynewbook
https://www.musi.co.kr/jupyter-book/mynewbook/
나는 작업공간을 바로 연결했는데, 작업공간과 빌드공간을 분리하는 것을 권장한다.
mymarkdownfile.md 파일을 생성하고 아래 내용 추가
# Here’s my sample title
This is some sample text.
(section-label)=
## Here’s my first sectionHere is a [reference to the intro](intro.md). Here is a reference to [](section-label).
#은 타이틀을 의미하고 ##는 큰 글씨?
(section-label)는 섹션의 헤더
파일 링크 연결시 []로 링크메세지이고 실제 연결될 페이지는 ()안에 적는다.
새로 생성한 파일을 목록에 추가
_toc.yml 파일 하단에 아래와 같이 추가
# In _toc.yml
format: jb-book
root: intro
chapters:
– file: markdown
– file: notebooks
– file: markdown-notebooks
– file: mymarkdownfile
다시 빌드하기
$ jupyter-book build mynewbook
빌드후 결과 확인
https://www.musi.co.kr/jupyter-book/mynewbook/
하단에 추가한 파일에 대한 정보가 표시된다.(제목으로)