mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-15 18:17:35 +02:00
62 lines
No EOL
9.7 KiB
HTML
62 lines
No EOL
9.7 KiB
HTML
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Site Preparation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta property="og:title" content="Site Preparation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="After [installing Docusaurus](/docs/en/installation.html), you will want to install and run the example site included. This serves dual purposes."/><meta name="robots" content="noindex"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="/css/main.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script async="" defer="" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/solarized-dark.min.css"/></head><body class="sideNavVisible"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/docusaurus.svg"/><h2 class="headerTitle">Docusaurus</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li><a href="/docs/en/installation.html" target="_self">Docs</a></li><li><a href="/en/help.html" target="_self">Help</a></li><li><a href="/blog" target="_self">Blog</a></li><li><a href="https://github.com/facebookexperimental/docusaurus" target="_self">GitHub</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Getting Started</span></h2></div><div class="navGroups"><div class="navGroup navGroupActive"><h3>Getting Started</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/installation.html">Installation</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/en/site-preparation.html">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-creation.html">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/en/publishing.html">Publishing your site</a></li></ul></div><div class="navGroup navGroupActive"><h3>Guides</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/custom-pages.html">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/en/navigation.html">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/en/blog.html">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/en/translation.html">Translations & Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/search.html">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/en/versioning.html">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/commands.html">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/en/api-pages.html">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-config.html">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/en/doc-markdown.html">Markdown Features</a></li></ul></div></div></section></div><script>
|
||
var toggler = document.getElementById('navToggler');
|
||
var nav = document.getElementById('docsNav');
|
||
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</a><h1>Site Preparation</h1></header><article><div><span><p>After <a href="/docs/en/installation.html">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><code class="hljs">npm <span class="hljs-keyword">run</span><span class="bash"> examples
|
||
</span></code></pre>
|
||
<p>or</p>
|
||
<pre><code class="hljs">yarn <span class="hljs-keyword">run</span><span class="bash"> examples
|
||
</span></code></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><code class="hljs">npm <span class="hljs-keyword">run</span><span class="bash"> start
|
||
</span></code></pre>
|
||
<p>or</p>
|
||
<pre><code class="hljs">yarn <span class="hljs-keyword">run</span><span class="bash"> start
|
||
</span></code></pre></li>
|
||
<li><p>Load the example site at http://localhost:3000. 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><code class="hljs">website/core/Footer.js
|
||
website/pages/...
|
||
website/static/img/...
|
||
website/siteConfig.js
|
||
website/blog-examples-<span class="hljs-keyword">from</span>-docusaurus/...
|
||
docs-examples-<span class="hljs-keyword">from</span>-docusaurus/...
|
||
</code></pre>
|
||
<blockquote>
|
||
<p>The <code>docs-examples-from-docusaurus</code> folder will be at the same directory level as <code>website</code>, not in it.</p>
|
||
</blockquote>
|
||
<p>The provided example files contain configurations that can be used as starting points for your site:</p>
|
||
<ul>
|
||
<li>The <code>website/core/Footer.js</code> file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.</li>
|
||
<li>The <code>website/blog-examples-from-docusaurus</code> folder contains examples of blog posts written in markdown.</li>
|
||
<li>The <code>docs-examples-from-docusaurus</code> folder contains example documentation files written in markdown.</li>
|
||
<li>The <code>website/pages</code> folder contains example top-level pages for the site.</li>
|
||
<li>The <code>website/static</code> folder contains static assets used by the example site.</li>
|
||
<li>The <code>website/siteConfig.js</code> file is the main configuration file used by Docusaurus.</li>
|
||
</ul>
|
||
<p>You will need to keep the <code>website/siteConfig.js</code> and <code>website/core/Footer.js</code> files, but may edit them as you wish.</p>
|
||
<p>You should keep the <code>website/pages</code> and <code>website/static</code> folders, but may change the content inside them as you wish. At the bare minimum you should have an <code>en/index.js</code> or <code>en/index.html</code> file inside <code>website/pages</code> and an image to use as your header icon inside <code>website/static</code>.</p>
|
||
<p>The <code>website/blog-examples-from-docusaurus</code> and <code>docs-examples-from-docusaurus</code> folders contain example blog and document markdown files. If you wish to run Docusaurus with these files, you need to rename the folders to <code>website/blog</code> and <code>docs</code>, respectively.</p>
|
||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="installation.html">← Installation</a><a class="docs-next button" href="site-creation.html">Creating your site →</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"><span>Copyright © 2017 Facebook Inc.</span></section></footer></div><script type="text/javascript" src="//cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
|
||
var search = docsearch({
|
||
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
|
||
indexName: 'docusaurus',
|
||
inputSelector: '#search_input_react'
|
||
});
|
||
</script></body></html> |