mkdocs

[mkdocs] mkdocs 의 hooks 기능 사용법.

mkdocs 를 build할 때, 특정 파일을 build 시 build된 파일들이 놓이는 특정 디렉토리에 특정 파일들을 카피해야하는 경우가 있을 수 있는데, 이를 build하고 gh-deploy 로 수행할 경우 매번 카피해주기가 매우 귀찮다. 이 문서는 build등의 event가 발생할 경우 자동으로 특정 파일을 카피하는 처리를 수행하도록 하는 방법으로 mkdocs 1.4버전 부터 지원하는 hooks를 사용한다. 단, mkdocs 1.4 이전은 별도의 plug-in을 이용해야 한다. 이 경우는 다음 글을 참고할 곳. 2023.04.07 - [Computer/ETC] - [mkdocs] mkdocs build 등에서 특정 파일 카피 설정. [mkdocs] mkdocs build 등에서 특정 파일 카피 설정..

[mkdocs] custom domain 사용하기.

github.io 등에 mkdocs의 materials theme를 이용할 때, mkdocs gh-deploy를 사용할 경우, 매번 custom domain설정이 초기화되었음. 이를 막기 위해서는 mkdocs.yml 파일에서 docs_dir로 지정된 디렉토리 밑에 CNAME이라는 파일을 만들고, 해당 파일에 사용하고자 하는 custom domain을 입력해두면 된다.

[mkdocs] mkdocs build 등에서 특정 파일 카피 설정.

mkdocs 를 build할 때, 특정 파일을 build 시 build된 파일들이 놓이는 특정 디렉토리에 특정 파일들을 카피해야하는 경우가 있을 수 있는데, 이를 매번 build하고 gh-deploy 로 적용할 때 자동화되어있지 않을 경우 자주 잊어버려 해당 파일에 대한 링크가 깨지는 경우들이 발생하는 등의 문제가 일어날 수 있다. 2023.07.26 변경 사항 위의 문제를 해결하기 위해 mkdocs 1.4 전에는 mkdocs-simple-hooks plugin을 사용하여 처리했었다. 하지만, mkdocs 1.4 이후부터는 hooks를 mkdocs 자체적으로 지원을 하게 되었고, 이를 이용하는게 낫다. 해당 내용은 다음을 참고하라. https://dsaint31.tistory.com/entry/mkdoc..