mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-01 18:32:52 +02:00
parent
b695034586
commit
540f7da203
28 changed files with 200 additions and 4 deletions
|
@ -157,6 +157,19 @@
|
|||
</code></pre>
|
||||
<h4><a class="anchor" aria-hidden="true" id="defaultversionshown-string"></a><a href="#defaultversionshown-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>defaultVersionShown</code> [string]</h4>
|
||||
<p>The default version for the site to be shown. If this is not set, the latest version will be shown.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="deleteddocs-object"></a><a href="#deleteddocs-object" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>deletedDocs</code> [object]</h4>
|
||||
<p>Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to <a href="versioning#fallback-functionality">fallback functionality</a>. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.</p>
|
||||
<p>To force removal of content beginning with a certain version (including for current/next), add a <code>deletedDocs</code> object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.</p>
|
||||
<p>예제:</p>
|
||||
<pre><code class="hljs css language-js">{
|
||||
<span class="hljs-attr">deletedDocs</span>: {
|
||||
<span class="hljs-string">"2.0.0"</span>: [
|
||||
<span class="hljs-string">"tagging"</span>
|
||||
]
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>The version keys must match those in <code>versions.json</code>. Assuming the versions list in <code>versions.json</code> is <code>["3.0.0", "2.0.0", "1.1.0", "1.0.0"]</code>, the <code>docs/1.0.0/tagging</code> and <code>docs/1.1.0/tagging</code> URLs will work but <code>docs/2.0.0/tagging</code>, <code>docs/3.0.0/tagging</code>, and <code>docs/tagging</code> will not. The files and folders for those versions will not be generated during the build.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="docsurl-string"></a><a href="#docsurl-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>docsUrl</code> [string]</h4>
|
||||
<p>The base URL for all docs file. Set this field to <code>''</code> to remove the <code>docs</code> prefix of the documentation URL. If unset, it is defaulted to <code>docs</code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="disableheadertitle-boolean"></a><a href="#disableheadertitle-boolean" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>disableHeaderTitle</code> [boolean]</h4>
|
||||
|
|
|
@ -157,6 +157,19 @@
|
|||
</code></pre>
|
||||
<h4><a class="anchor" aria-hidden="true" id="defaultversionshown-string"></a><a href="#defaultversionshown-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>defaultVersionShown</code> [string]</h4>
|
||||
<p>The default version for the site to be shown. If this is not set, the latest version will be shown.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="deleteddocs-object"></a><a href="#deleteddocs-object" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>deletedDocs</code> [object]</h4>
|
||||
<p>Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to <a href="versioning#fallback-functionality">fallback functionality</a>. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.</p>
|
||||
<p>To force removal of content beginning with a certain version (including for current/next), add a <code>deletedDocs</code> object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.</p>
|
||||
<p>예제:</p>
|
||||
<pre><code class="hljs css language-js">{
|
||||
<span class="hljs-attr">deletedDocs</span>: {
|
||||
<span class="hljs-string">"2.0.0"</span>: [
|
||||
<span class="hljs-string">"tagging"</span>
|
||||
]
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>The version keys must match those in <code>versions.json</code>. Assuming the versions list in <code>versions.json</code> is <code>["3.0.0", "2.0.0", "1.1.0", "1.0.0"]</code>, the <code>docs/1.0.0/tagging</code> and <code>docs/1.1.0/tagging</code> URLs will work but <code>docs/2.0.0/tagging</code>, <code>docs/3.0.0/tagging</code>, and <code>docs/tagging</code> will not. The files and folders for those versions will not be generated during the build.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="docsurl-string"></a><a href="#docsurl-string" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>docsUrl</code> [string]</h4>
|
||||
<p>The base URL for all docs file. Set this field to <code>''</code> to remove the <code>docs</code> prefix of the documentation URL. If unset, it is defaulted to <code>docs</code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="disableheadertitle-boolean"></a><a href="#disableheadertitle-boolean" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>disableHeaderTitle</code> [boolean]</h4>
|
||||
|
|
|
@ -124,6 +124,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="이전-버전으로-되돌리기"></a><a href="#이전-버전으로-되돌리기" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>이전 버전으로 되돌리기</h2>
|
||||
<p><code>docs</code> 디렉토리에 있는 파일과 사이드바 파일은 새로운 버전으로 생성된 파일들과는 다를 수 있습니다. 버전 간 차이가 없다면 도큐사우르스에서는 최신 버전의 파일을 사용하게 됩니다.</p>
|
||||
<p>예를 들어 original id가 <code>doc1</code>인 문서의 버전이 <code>1.0.0</code>이라고 할때 id가 <code>doc1</code>인 같은 콘텐츠인 문서가 <code>docs</code> 디렉토리에 있습니다. <code>2.0.0</code> 버전이 생성되면 <code>doc1</code> 문서는 <code>versioned_docs/version-2.0.0/</code>으로 복사되지 않습니다. <code>docs/2.0.0/doc1.html</code>라는 페이지가 만들어지긴 하지만 사용하는 파일은 <code>1.0.0</code> 버전의 파일을 사용하게 됩니다.</p>
|
||||
<p>Because of the way this fallback works, pages that you delete are not really deleted from the website unless you tell Docusaurus to skip fallback after a certain version. To do this, use the <a href="/docs/ko/next/site-config#deleteddocs-object"><code>deletedDocs</code></a> option in <code>siteConfig.js</code>.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="기존에-생성한-버전-번호-변경하기"></a><a href="#기존에-생성한-버전-번호-변경하기" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>기존에 생성한 버전 번호 변경하기</h2>
|
||||
<p>기존에 생성한 버전 번호를 변경하려면 먼저 아래의 스크립트를 <code>package.json</code> 파일에 추가힙니다.</p>
|
||||
<pre><code class="hljs css language-js">...
|
||||
|
|
|
@ -124,6 +124,7 @@
|
|||
<h2><a class="anchor" aria-hidden="true" id="이전-버전으로-되돌리기"></a><a href="#이전-버전으로-되돌리기" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>이전 버전으로 되돌리기</h2>
|
||||
<p><code>docs</code> 디렉토리에 있는 파일과 사이드바 파일은 새로운 버전으로 생성된 파일들과는 다를 수 있습니다. 버전 간 차이가 없다면 도큐사우르스에서는 최신 버전의 파일을 사용하게 됩니다.</p>
|
||||
<p>예를 들어 original id가 <code>doc1</code>인 문서의 버전이 <code>1.0.0</code>이라고 할때 id가 <code>doc1</code>인 같은 콘텐츠인 문서가 <code>docs</code> 디렉토리에 있습니다. <code>2.0.0</code> 버전이 생성되면 <code>doc1</code> 문서는 <code>versioned_docs/version-2.0.0/</code>으로 복사되지 않습니다. <code>docs/2.0.0/doc1.html</code>라는 페이지가 만들어지긴 하지만 사용하는 파일은 <code>1.0.0</code> 버전의 파일을 사용하게 됩니다.</p>
|
||||
<p>Because of the way this fallback works, pages that you delete are not really deleted from the website unless you tell Docusaurus to skip fallback after a certain version. To do this, use the <a href="/docs/ko/next/site-config#deleteddocs-object"><code>deletedDocs</code></a> option in <code>siteConfig.js</code>.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="기존에-생성한-버전-번호-변경하기"></a><a href="#기존에-생성한-버전-번호-변경하기" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>기존에 생성한 버전 번호 변경하기</h2>
|
||||
<p>기존에 생성한 버전 번호를 변경하려면 먼저 아래의 스크립트를 <code>package.json</code> 파일에 추가힙니다.</p>
|
||||
<pre><code class="hljs css language-js">...
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue