Skip to content

Documenter 사용법

WooKyoung Noh edited this page Dec 8, 2017 · 4 revisions

줄리아 문서 번역하기

번역 문서 텍스트는 Documenter 문법으로 된 마크다운으로 되어 있습니다.

@ref, @id

Documenter는 마크다운 헤딩(heading, ###, ##로 시작)를 기본 참조 id로 사용합니다. 따라서 헤딩을 한글로 번역한 후에는 @id를 추가해 주어야 제대로 참조가 걸립니다.

예를 들어 julia-0.7 make.jl로 빌드했을 경우 다음과 같은 @ref 메시지가 나오면

 !! Invalid local link: unresolved path
    '@ref Broadcasting' in manual/mathematical-operations.md
...

Broadcasting을 참조할 수 없다는 메시지입니다. src/manual/arrays.md 파일을 열어

### [브로드캐스팅](@id Broadcasting)

이런 식으로 다른 문서에서 크로스 참조가 되도록 해주면 됩니다.

@id를 지정하였다면 [브로드캐스팅](@ref Broadcasting)을 보세요 이런 식으로 참조를 걸면 됩니다.

참조를 할때 사용하는 @ref@id는 다음 문서를 참고하세요.