yan
/
docusaurus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
docusaurus/docs/en/installation.html

73 lines
12 KiB
HTML
Raw Normal View History

Deploy website Deploy website version based on 35f4819fed98655c0a49caf767fe6e8c774b7684
2018-04-27 09:24:10 -04:00
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Installation · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta property="og:title" content="Installation · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:"/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><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="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.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 type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/css/main.css"/></head><body class="sideNavVisible doc separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitle">Docusaurus</h2></a><a href="/en/versions.html"><h3>1.0.14</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive siteNavItemActive"><a href="/docs/en/installation.html" target="_self">Docs</a></li><li class=""><a href="/en/help.html" target="_self">Help</a></li><li class=""><a href="/en/users.html" target="_self">Users</a></li><li class=""><a href="/en/about-slash.html" target="_self">About /</a></li><li class=""><a href="/blog" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="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 navListItemActive"><a class="navItem navItemActive" href="/docs/en/installation.html">Installation</a></li><li class="navListItem"><a class="navItem" 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/blog.html">Adding a Blog</a></li><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/search.html">Enabling Search</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/translation.html">Translations &amp; Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/version
Deploy website Deploy website version based on 2a7ab6267748e10d26f407399cb22ea1a835d29e
2017-12-19 12:24:56 -05:00
var toggler = document.getElementById('navToggler');
var nav = document.getElementById('docsNav');
toggler.onclick = function() {
nav.classList.toggle('docsSliderActive');
};
Deploy website Deploy website version based on 2e30a5e804422bc2a5b4333c744239c69d647c71
2018-04-07 22:15:39 -04:00
</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/facebook/docusaurus/edit/master/docs/getting-started-installation.md" target="_blank" rel="noreferrer noopener">Edit</a><h1>Installation</h1></header><article><div><span><p>Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:</p>
Deploy website Deploy website version based on 2a7ab6267748e10d26f407399cb22ea1a835d29e
2017-12-19 12:24:56 -05:00
<ol>
Deploy website Deploy website version based on 2e404a5c19a12cf7c0ea148510086fad7162e899
2018-03-15 10:23:00 -04:00
<li><p>Ensure you have the latest version of <a href="https://nodejs.org/en/download/">Node</a> installed. We also recommend you install <a href="https://yarnpkg.com/en/docs/install">Yarn</a> as well.</p>
<blockquote>
<p>While we recommend Node 8.x or greater, your Node version must at least 6.x.</p>
</blockquote></li>
<li><p>Go into the root of your GitHub repo directory where you will be creating the docs.</p></li>
Deploy website Deploy website version based on 0a91c32c85ec6475bf2ee55353f5c1efefd1877f
2018-04-23 19:43:10 -04:00
<li><p><code>npx docusaurus-init</code></p>
<blockquote>
<p>If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run <code>yarn global add docusaurus-init</code> or <code>npm install --global docusaurus-init</code>. After that, run <code>docusaurus-init</code>.</p>
</blockquote></li>
Deploy website Deploy website version based on 2a7ab6267748e10d26f407399cb22ea1a835d29e
2017-12-19 12:24:56 -05:00
</ol>
Deploy website Deploy website version based on 0925895d3bf80fad9bbf674e753dd0f2e107ff03
2018-03-16 17:08:21 -04:00
<blockquote>
Deploy website Deploy website version based on 0a91c32c85ec6475bf2ee55353f5c1efefd1877f
2018-04-23 19:43:10 -04:00
<p>After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the <code>website</code> directory and typing <code>yarn outdated docusaurus</code> or <code>npm outdated docusaurus</code>. You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by typing <code>yarn upgrade docusaurus --latest</code> or <code>npm update docusaurus</code>.</p>
Deploy website Deploy website version based on 0925895d3bf80fad9bbf674e753dd0f2e107ff03
2018-03-16 17:08:21 -04:00
</blockquote>
Deploy website Deploy website version based on 0a91c32c85ec6475bf2ee55353f5c1efefd1877f
2018-04-23 19:43:10 -04:00
<h2><a class="anchor" aria-hidden="true" id="verifying-installation"></a><a href="#verifying-installation" aria-hidden="true" class="hash-link" ><svg 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>Verifying Installation</h2>
Deploy website Deploy website version based on ee8c802fa48b5b6c1cfef806fa668d7cea8152c9
2018-02-12 21:14:34 -05:00
<p>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
Deploy website Deploy website version based on 2a7ab6267748e10d26f407399cb22ea1a835d29e
2017-12-19 12:24:56 -05:00
<pre><code class="hljs css bash">root-of-repo
├── docs-examples-from-docusaurus
│ └── doc1.md
│ └── doc2.md
│ └── doc3.md
│ └── exampledoc4.md
│ └── exampledoc5.md
└── website
│ └── blog-examples-from-docusaurus
│ └── 2016-03-11-blog-post.md
│ └── 2017-04-10-blog-post-two.md
│ └── core
│ └── Footer.js
│ └── node_modules
│ └── package.json
│ └── pages
│ └── sidebars.json
│ └── siteConfig.js
│ └── static
</code></pre>
Deploy website Deploy website version based on a81d7e0b00bb8ebe18bfecbceaae39914c6ab42b
2018-02-12 21:05:23 -05:00
<p>Running the Docusaurus initialization script, <code>docusaurus-init</code>, produces a runnable, example website to base your site upon.</p>
<ol>
<li>In your root, rename <code>docs-examples-from-docusaurus</code> to <code>docs</code>.</li>
<li><code>cd website</code></li>
<li>Rename <code>blog-examples-from-docusaurus</code> to <code>blog</code>.</li>
<li>Run the local webserver via <code>yarn start</code> or <code>npm start</code>.</li>
<li>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.</li>
</ol>
<p><img src="/img/getting-started-preparation-verify.png" alt=""></p>
Deploy website Deploy website version based on c6abf967685b822b9125afc05e953228f1b8561a
2018-03-12 19:28:43 -04:00
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="site-preparation.html">Site Preparation →</a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#verifying-installation">Verifying Installation</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><h5>Docs</h5><a href="
Deploy website Deploy website version based on 2a7ab6267748e10d26f407399cb22ea1a835d29e
2017-12-19 12:24:56 -05:00
/docs/en/installation.html">Getting Started</a><a href="
/docs/en/versioning.html">Versioning</a><a href="
/docs/en/translation.html">Localization</a><a href="
Deploy website Deploy website version based on 2e30a5e804422bc2a5b4333c744239c69d647c71
2018-04-07 22:15:39 -04:00
/docs/en/search.html">Adding Search</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="https://twitter.com/docusaurus">Twitter</a></div><div><h5>More</h5><a href="https://github.com/facebook/docusaurus">GitHub</a><a class="github-button" href="https://github.com/facebook/Docusaurus" data-icon="octicon-star" data-count-href="/facebook/Docusaurus/stargazers" data-count-api="/repos/facebook/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" rel="noreferrer noopener" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright"><span>Copyright © 2018 Facebook Inc.</span></section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
Deploy website Deploy website version based on 2a7ab6267748e10d26f407399cb22ea1a835d29e
2017-12-19 12:24:56 -05:00
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44373548-31', 'auto');
ga('send', 'pageview');
</script><script>window.fbAsyncInit = function() {FB.init({appId:'1615782811974223',xfbml:true,version:'v2.7'});};(function(d, s, id){var js, fjs = d.getElementsByTagName(s)[0];if (d.getElementById(id)) {return;}js = d.createElement(s); js.id = id;js.src = '//connect.facebook.net/en_US/sdk.js';fjs.parentNode.insertBefore(js, fjs);}(document, 'script','facebook-jssdk'));
</script><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script><script>
var search = docsearch({
Deploy website Deploy website version based on b0da89c9487a7d2a6f515a6030b8f6dfc09d5e83
2018-03-04 00:46:53 -05:00
Deploy website Deploy website version based on 2a7ab6267748e10d26f407399cb22ea1a835d29e
2017-12-19 12:24:56 -05:00
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
indexName: 'docusaurus',
inputSelector: '#search_input_react'
});
</script></body></html>