mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-30 09:27:04 +02:00
update website [ci skip]
This commit is contained in:
Facebook GitHub Bot
parent
f060894394
commit
8947af4c99
1 changed files with 3 additions and 3 deletions
|
|
@ -8,14 +8,14 @@
|
|||
<span class="token operator">...</span>
|
||||
<span class="token punctuation">{</span>blog<span class="token punctuation">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> label<span class="token punctuation">:</span> <span class="token string">'Blog'</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
|
||||
<span class="token operator">...</span>
|
||||
<span class="token punctuation">]</span></pre><h2><a class="anchor" name="adding-blog-posts"></a>Adding blog posts <a class="hash-link" href="#adding-blog-posts">#</a></h2><p>To publish in the blog, create a file within the blog folder with a formatted name of <code>YYYY-MM-DD-My-Blog-Post-Title.md</code>. The post date is extracted from the file name.</p><p>For example, we will create the following file <code>website/blog/2017-08-18-Introducing-Docusaurus.md</code>:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||
<span class="token punctuation">]</span></pre><h2><a class="anchor" name="adding-posts"></a>Adding Posts <a class="hash-link" href="#adding-posts">#</a></h2><p>To publish in the blog, create a file within the blog folder with a formatted name of <code>YYYY-MM-DD-My-Blog-Post-Title.md</code>. The post date is extracted from the file name.</p><p>For example, at <code>website/blog/2017-08-18-Introducing-Docusaurus.md</code>:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||
author<span class="token punctuation">:</span> Frank Li
|
||||
authorURL<span class="token punctuation">:</span> https<span class="token punctuation">:</span><span class="token operator">/</span><span class="token operator">/</span>twitter<span class="token punctuation">.</span>com<span class="token operator">/</span>foobarbaz
|
||||
authorFBID<span class="token punctuation">:</span> <span class="token number">503283835</span>
|
||||
title<span class="token punctuation">:</span> Introducing Docusaurus
|
||||
<span class="token operator">--</span><span class="token operator">-</span>
|
||||
|
||||
Lorem Ipusm<span class="token punctuation">.</span><span class="token punctuation">.</span></pre><h2><a class="anchor" name="blog-post-summaries"></a>Blog Post Summaries <a class="hash-link" href="#blog-post-summaries">#</a></h2><p>Use the <code><!--truncate--></code> marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above <code><!--truncate--></code> will be part of the summary. For example:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||
Lorem Ipusm<span class="token punctuation">.</span><span class="token punctuation">.</span></pre><h2><a class="anchor" name="header-options"></a>Header Options <a class="hash-link" href="#header-options">#</a></h2><p>The only required field is <code>title</code>; however, we provide options to add author information to your blog post as well.</p><ul><li><code>author</code> - The text label of the author byline.</li><li><code>authorURL</code> - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.</li><li><code>authorFBID</code> - The Facebook ID that is used to extract the profile picture.</li><li><code>title</code> - The blog post title.</li></ul><h2><a class="anchor" name="summary-truncation"></a>Summary Truncation <a class="hash-link" href="#summary-truncation">#</a></h2><p>Use the <code><!--truncate--></code> marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above <code><!--truncate--></code> will be part of the summary. For example:</p><pre class="prism language-javascript"><span class="token operator">--</span><span class="token operator">-</span>
|
||||
title<span class="token punctuation">:</span> Truncation Exmaple
|
||||
<span class="token operator">--</span><span class="token operator">-</span>
|
||||
|
||||
|
|
@ -29,5 +29,5 @@ But anything <span class="token keyword">from</span> here on down will not be<sp
|
|||
|
||||
Not <span class="token keyword">this</span><span class="token punctuation">.</span>
|
||||
|
||||
Or <span class="token keyword">this</span><span class="token punctuation">.</span></pre><h2><a class="anchor" name="special-blog-post-header-options"></a>Special blog post header options <a class="hash-link" href="#special-blog-post-header-options">#</a></h2><p>The only required field is <code>title</code>; however, we provide options to add author information to your blog post as well.</p><ul><li><code>author</code> - The text label of the author byline.</li><li><code>authorURL</code> - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.</li><li><code>authorFBID</code> - The Facebook ID that is used to extract the profile picture.</li><li><code>title</code> - The blog post title.</li></ul></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="navigation.html#content">← Previous</a><a class="docs-next button" href="translation.html#content">Next →</a></div></div></div></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><h5>Docs</h5><a href="
|
||||
Or <span class="token keyword">this</span><span class="token punctuation">.</span></pre></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="navigation.html#content">← Previous</a><a class="docs-next button" href="translation.html#content">Next →</a></div></div></div></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><h5>Docs</h5><a href="
|
||||
/docs/installation.html">Getting Started</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a></div><div><h5>More</h5><a href="https://github.com/facebookexperimental/docusaurus">GitHub</a><a class="github-button" href="https://github.com/facebookexperimental/docusaurus" data-icon="octicon-star" data-count-href="/facebookexperimental/docusaurus/stargazers" data-count-api="/repos/facebookexperimental/docusaurus#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright">Copyright © 2017 Facebook Inc.</section></footer></div></body></html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue