mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 16:59:06 +02:00
parent
9e0b0b116a
commit
ca8cdae117
10 changed files with 102 additions and 2 deletions
|
@ -236,8 +236,18 @@
|
|||
<p>Path to your web app manifest (e.g., <code>manifest.json</code>). This will add a <code><link></code> tag to <code><head></code> with <code>rel</code> as <code>"manifest"</code> and <code>href</code> as the provided path.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="markdownoptions-object"></a><a href="#markdownoptions-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>markdownOptions</code> [object]</h4>
|
||||
<p>Override default <a href="https://github.com/jonschlinkert/remarkable#options">Remarkable options</a> that will be used to render markdown.</p>
|
||||
<blockquote>
|
||||
<p>To manage <a href="https://github.com/jonschlinkert/remarkable#syntax-extensions">syntax extensions</a>, use the <code>markdownPlugins</code> field.</p>
|
||||
</blockquote>
|
||||
<h4><a class="anchor" aria-hidden="true" id="markdownplugins-array"></a><a href="#markdownplugins-array" 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>markdownPlugins</code> [array]</h4>
|
||||
<p>An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.</p>
|
||||
<p>For example, if you want to <a href="https://github.com/jonschlinkert/remarkable#syntax-extensions">enable superscript and subscript</a> in your markdown that is rendered by Remarkable to HTML, you would do the following:</p>
|
||||
<pre><code class="hljs"> markdownPlugins: [
|
||||
function foo(md) {
|
||||
md.inline.ruler.enable(['sub', 'sup']);
|
||||
},
|
||||
],
|
||||
</code></pre>
|
||||
<h4><a class="anchor" aria-hidden="true" id="noindex-boolean"></a><a href="#noindex-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>noIndex</code> [boolean]</h4>
|
||||
<p>Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.</p>
|
||||
<h4><a class="anchor" aria-hidden="true" id="ogimage-string"></a><a href="#ogimage-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>ogImage</code> [string]</h4>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue