3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 08:19:07 +02:00
Code Issues Projects Releases Packages Wiki Activity

update website [ci skip]

Browse source
This commit is contained in:
Facebook GitHub Bot 2017-10-23 22:03:06 +00:00
parent 7275161e21
commit 731f677df8
14 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/en/site-preparation.html
View file

@ -4,7 +4,7 @@
toggler.onclick = function() {
nav.classList.toggle('docsSliderActive');
};
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/facebookexperimental/docusaurus/edit/master/docs/getting-started-preparation.md" target="_blank">Edit this Doc</a><h1>Site Preparation</h1></header><article><div><p>After <a href="/docs/en/installation.html" target="">installing Docusaurus</a>, you will want to install and run the example site included. This serves dual purposes.</p><ol><li>Verifying that Docusaurus was installed correctly.</li><li>Providing you the skeleton to create your site.</li></ol><h2><a class="anchor" name="verifying-installation"></a>Verifying Installation <a class="hash-link" href="#verifying-installation">#</a></h2><ol><li><p>Generate the files for the example site by running <code>examples</code> using <code>yarn</code> or <code>npm</code>.</p><pre class="prism language-javascript"> npm run examples</pre><p> or</p><pre class="prism language-javascript"> yarn run examples</pre><blockquote><p>If any of the files created by <code>[yarn | npm] run examples</code> already exists, Docusaurus will not overwrite them.</p></blockquote></li><li><p>Run the server.</p><pre class="prism language-javascript"> npm run start</pre><p> or</p><pre class="prism language-javascript"> yarn run start</pre></li><li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a>. You should see the example site loaded in your web browser.</p></li></ol><h2><a class="anchor" name="example-site-configuration"></a>Example Site Configuration <a class="hash-link" href="#example-site-configuration">#</a></h2><p>Loading the example site will create the following files/folders:</p><pre class="prism language-javascript">website<span class="token operator">/</span>core<span class="token operator">/</span>Footer<span class="token punctuation">.</span>js
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/facebookexperimental/docusaurus/edit/master/docs/getting-started-preparation.md" target="_blank">Edit</a><h1>Site Preparation</h1></header><article><div><p>After <a href="/docs/en/installation.html" target="">installing Docusaurus</a>, you will want to install and run the example site included. This serves dual purposes.</p><ol><li>Verifying that Docusaurus was installed correctly.</li><li>Providing you the skeleton to create your site.</li></ol><h2><a class="anchor" name="verifying-installation"></a>Verifying Installation <a class="hash-link" href="#verifying-installation">#</a></h2><ol><li><p>Generate the files for the example site by running <code>examples</code> using <code>yarn</code> or <code>npm</code>.</p><pre class="prism language-javascript"> npm run examples</pre><p> or</p><pre class="prism language-javascript"> yarn run examples</pre><blockquote><p>If any of the files created by <code>[yarn | npm] run examples</code> already exists, Docusaurus will not overwrite them.</p></blockquote></li><li><p>Run the server.</p><pre class="prism language-javascript"> npm run start</pre><p> or</p><pre class="prism language-javascript"> yarn run start</pre></li><li><p>Load the example site at <a href="http://localhost:3000">http://localhost:3000</a>. You should see the example site loaded in your web browser.</p></li></ol><h2><a class="anchor" name="example-site-configuration"></a>Example Site Configuration <a class="hash-link" href="#example-site-configuration">#</a></h2><p>Loading the example site will create the following files/folders:</p><pre class="prism language-javascript">website<span class="token operator">/</span>core<span class="token operator">/</span>Footer<span class="token punctuation">.</span>js
website<span class="token regex">/pages/</span><span class="token operator">...</span>
website<span class="token operator">/</span><span class="token keyword">static</span><span class="token regex">/img/</span><span class="token operator">...</span>
website<span class="token operator">/</span>siteConfig<span class="token punctuation">.</span>js