Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown. -Markdown Headers -Documents +마크다운 헤더 +문서 Documents use the following markdown header fields that are enclosed by a line --- on either side: id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension). title: The title of your document. If this field is not present, the document's title will default to its id. @@ -91,16 +91,16 @@ 예를 들면 아래와 같습니다. --- id: doc1 -title: My Document -sidebar_label: Document +title: 내 문서 +sidebar_label: 문서 --- Versioned documents have their ids altered to include the version number when they get copied. The new id is version-${version}-${id} where ${version} is the version number of that document and ${id} is the original id. Additionally, versioned documents get an added original_id field with the original document id. 예를 들면 아래와 같습니다. --- id: version-1.0.0-doc1 -title: My Document -sidebar_label: Document +title: 내 문서 +sidebar_label: 문서 original_id: doc1 --- @@ -108,11 +108,11 @@ 예를 들면 아래와 같습니다. --- id: doc-markdown -title: Markdown Features +title: 마크다운 기능 custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md --- -Blog Posts +블로그 포스트 Blog posts use the following markdown header fields that are enclosed by a line --- on either side: title: The title of this blog post. author: The author of this blog post. If this field is omitted, no author name will be shown. @@ -120,22 +120,22 @@ authorFBID: The author's Facebook id, used only to get the author's profile picture to display with the blog post. If this field is omitted, no author picture will be shown for the blog post. 예를 들면 아래와 같습니다. --- -title: My First Blog Post -author: Frank Li +title: 내 첫번째 블로그 포스트 +author: 프랭크 리 authorURL: http://twitter.com/franchementli authorFBID: 100002976521003 --- -Extra Features +추가 기능 Docusaurus supports some extra features when writing documentation in markdown. 다른 문서로 연결하기 You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered. 예제: -[This links to another document](other-document.md) +[다른 문서의 링크](other-document.md) This markdown will automatically get converted into a link to /docs/other-document.html (or the appropriately translated/versioned link) once it gets rendered. This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct HTML links when they get rendered. -Linking to Images and Other Assets +이미지와 다른 내용물 연결 Static assets can be linked to in the same way that documents are, using relative URLs. Static assets used in documents and blogs should go into docs/assets and website/blog/assets, respectively. The markdown will get converted into correct link paths so that these paths will work for documents of all languages and versions. 예제:  @@ -146,11 +146,11 @@ 예제: ### `docusaurus.function(a, b)` -Text describing my function +내 함수를 설명하는 텍스트 ### `docdoc(file)` -Text describing my function +내 함수를 설명하는 텍스트 will lead to a table of contents of the functions: - `docusaurus.function(a, b)` @@ -167,7 +167,7 @@ Text describing my function
