메인 컨텐츠로 이동
Version: 2.0.0-beta.4 🚧

문서 마크다운 기능

문서 작업 시에는 기본적인 마크다운 기능은 모두 사용할 수 있습니다. 여기에 문서 작업에 특화된 마크다운 기능을 추가로 제공합니다.

마크다운 프런트 매터#

마크다운 문서는 마크다운 프런트 매터를 가지고 있습니다.

다른 문서 참조하기#

다른 문서 파일을 참조하려면 연결하길 원하는 문서의 상대 경로를 사용할 수 있습니다.

도큐사우루스는 파일 경로를 문서 URL 경로로 변환해줍니다(그리고 .md 확장자는 제거합니다).

예를 들어 folder/doc1.md 파일에서 folder/doc2.md, folder/subfolder/doc3.md, otherFolder/doc4.md 파일을 참조하고자 한다면 아래와 같이 설정할 수 있습니다.

I am referencing a [document](doc2.md).
Reference to another [document in a subfolder](subfolder/doc3.md).
[Relative document](../otherFolder/doc4.md) referencing works as well.
tip

상대 링크 대신 상대 파일 경로 링크를 사용하는 것이 좋습니다.

  • 깃헙 인터페이스에서 링크는 잘 동작합니다.
  • 모든 링크를 업데이트하지 않고 문서 슬러그만 원하는 형태로 변경할 수 있습니다.
  • 버전을 지원하는 문서에서 다른 문서에 대한 링크는 정확히 같은 버전으로 연결합니다.
  • 상대 링크는 trailingSlash 설정 변경 시 깨질 수 있습니다.