mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 16:59:06 +02:00
parent
0023724c6d
commit
fcfcadff40
579 changed files with 605 additions and 599 deletions
|
@ -133,8 +133,10 @@
|
|||
<p>An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as <code>Title • Tagline</code>. Set to <code>true</code> to make page titles just <code>Title</code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="editurl-string"></a><a href="#editurl-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>editUrl</code> [string]</h4>
|
||||
<p>URL for editing docs, usage example: <code>editUrl + 'en/doc1.md'</code>. If this field is omitted, there will be no "Edit this Doc" button for each document.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="enableupdatetime-string"></a><a href="#enableupdatetime-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>enableUpdateTime</code> [string]</h4>
|
||||
<p>An option to enable the docs showing last update time. Set to <code>true</code> to show a line at the bottom right corner of each doc page as <code>Last Updated: dd/mm/yyyy hh:MM:ss Z</code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="enableupdateby-boolean"></a><a href="#enableupdateby-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>enableUpdateBy</code> [boolean]</h4>
|
||||
<p>An option to enable the docs showing the author who last updated the doc. Set to <code>true</code> to show a line at the bottom right corner of each doc page as <code>Last updated by <Author Name></code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="enableupdatetime-boolean"></a><a href="#enableupdatetime-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>enableUpdateTime</code> [boolean]</h4>
|
||||
<p>An option to enable the docs showing last update time. Set to <code>true</code> to show a line at the bottom right corner of each doc page as <code>Last updated on <date></code>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="facebookappid-string"></a><a href="#facebookappid-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>facebookAppId</code> [string]</h4>
|
||||
<p>If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a <a href="https://www.facebook.com/help/audiencenetwork/804209223039296">Facebook application id</a>.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="facebookcomments-boolean"></a><a href="#facebookcomments-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>facebookComments</code> [boolean]</h4>
|
||||
|
@ -174,7 +176,7 @@
|
|||
<span class="hljs-comment">// ...</span>
|
||||
highlight: {
|
||||
<span class="hljs-comment">// The name of the theme used by Highlight.js when highlighting code.</span>
|
||||
<span class="hljs-comment">// You can find the list of supported themes here: </span>
|
||||
<span class="hljs-comment">// You can find the list of supported themes here:</span>
|
||||
<span class="hljs-comment">// https://github.com/isagalaev/highlight.js/tree/master/src/styles</span>
|
||||
theme: <span class="hljs-string">'default'</span>,
|
||||
|
||||
|
@ -186,7 +188,7 @@
|
|||
<span class="hljs-comment">// do something here</span>
|
||||
},
|
||||
|
||||
<span class="hljs-comment">// Default language. </span>
|
||||
<span class="hljs-comment">// Default language.</span>
|
||||
<span class="hljs-comment">// It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:</span>
|
||||
<span class="hljs-comment">// https://github.com/isagalaev/highlight.js/tree/master/src/languages</span>
|
||||
|
||||
|
@ -293,7 +295,7 @@
|
|||
idx,
|
||||
options,
|
||||
env,
|
||||
instance
|
||||
instance,
|
||||
</span>) </span>{
|
||||
<span class="hljs-keyword">return</span> <span class="hljs-string">'<div class="foo">bar</div>'</span>;
|
||||
};
|
||||
|
@ -302,16 +304,17 @@
|
|||
<span class="hljs-attr">scripts</span>: [
|
||||
<span class="hljs-string">'https://docusaurus.io/slash.js'</span>,
|
||||
{
|
||||
<span class="hljs-attr">src</span>: <span class="hljs-string">'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js'</span>,
|
||||
<span class="hljs-attr">async</span>: <span class="hljs-literal">true</span>
|
||||
}
|
||||
<span class="hljs-attr">src</span>:
|
||||
<span class="hljs-string">'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js'</span>,
|
||||
<span class="hljs-attr">async</span>: <span class="hljs-literal">true</span>,
|
||||
},
|
||||
],
|
||||
<span class="hljs-attr">stylesheets</span>: [
|
||||
<span class="hljs-string">'https://docusaurus.io/style.css'</span>,
|
||||
{
|
||||
<span class="hljs-attr">href</span>: <span class="hljs-string">'http://css.link'</span>,
|
||||
<span class="hljs-attr">type</span>: <span class="hljs-string">"text/css"</span>
|
||||
}
|
||||
<span class="hljs-attr">type</span>: <span class="hljs-string">'text/css'</span>,
|
||||
},
|
||||
],
|
||||
<span class="hljs-attr">facebookAppId</span>: <span class="hljs-string">'1615782811974223'</span>,
|
||||
<span class="hljs-attr">facebookComments</span>: <span class="hljs-literal">true</span>,
|
||||
|
@ -329,7 +332,7 @@
|
|||
|
||||
<span class="hljs-built_in">module</span>.exports = siteConfig;
|
||||
</code></pre>
|
||||
</span></div></article></div><div class="docLastUpdateTimestamp"><em><strong>Last updated: </strong>2018-10-17 17:21:10</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/api-pages"><span class="arrow-prev">← </span><span>Previous</span></a></div></div></div><nav class="onPageNav docOnPageNav"><ul class="toc-headings"><li><a href="#user-showcase">User Showcase</a></li><li><a href="#siteconfig-fields">siteConfig Fields</a><ul class="toc-headings"><li><a href="#mandatory-fields">Mandatory Fields</a></li><li><a href="#optional-fields">Optional Fields</a></li></ul></li><li><a href="#example-siteconfigjs-with-many-available-fields">Example siteConfig.js with many available fields</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2018-10-18 by Fienny Angelina</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/api-pages"><span class="arrow-prev">← </span><span>Previous</span></a></div></div></div><nav class="onPageNav docOnPageNav"><ul class="toc-headings"><li><a href="#user-showcase">User Showcase</a></li><li><a href="#siteconfig-fields">siteConfig Fields</a><ul class="toc-headings"><li><a href="#mandatory-fields">Mandatory Fields</a></li><li><a href="#optional-fields">Optional Fields</a></li></ul></li><li><a href="#example-siteconfigjs-with-many-available-fields">Example siteConfig.js with many available fields</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
|
||||
/docs/en/installation">Getting Started</a><a href="
|
||||
/docs/en/versioning">Versioning</a><a href="
|
||||
/docs/en/translation">Localization</a><a href="
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue