mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-23 05:57:05 +02:00
31 lines
No EOL
10 KiB
HTML
31 lines
No EOL
10 KiB
HTML
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1"/><title>Publishing Your Website · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta property="og:title" content="Publishing Your Website · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/index.html"/><meta property="og:description" content="## Automatically Publish Your Website with Circle"/><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></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 target="_self"></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#content">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-preparation.html#content">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-creation.html#content">Creating your site</a></li><li class="navListItem navListItemActive"><a class="navItem navItemActive" href="/docs/en/publish.html#content">Publishing Your Website</a></li><li class="navListItem"><a class="navItem" href="/docs/en/publishing.html#content">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#content">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/en/navigation.html#content">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/en/blog.html#content">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/en/translation.html#content">Translations & Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/search.html#content">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/en/versioning.html#content">Versioning</a></li></ul></div><div class="navGroup navGroupActive"><h3>API</h3><ul><li class="navListItem"><a class="navItem" href="/docs/en/commands.html#content">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/en/api-pages.html#content">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/en/site-config.html#content">siteConfig.js</a></li><li class="navListItem"><a class="navItem" href="/docs/en/doc-markdown.html#content">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-publish.md" target="_blank">Edit this Doc</a><h1>Publishing Your Website</h1></header><article><div><h2><a class="anchor" name="automatically-publish-your-website-with-circle"></a>Automatically Publish Your Website with Circle <a class="hash-link" href="#automatically-publish-your-website-with-circle">#</a></h2><p>You can use CircleCI to publish your website whenever your project repo is updated. Configure your circle.yml file in your project repo to run commands to publish to GitHub Pages. An example is shown here:</p><pre class="prism language-yaml"><span class="token key atrule">machine</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">node</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">version</span><span class="token punctuation">:</span> 6.10.3
|
||
<span class="token key atrule">npm</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">version</span><span class="token punctuation">:</span> 3.10.10
|
||
|
||
<span class="token key atrule">test</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">override</span><span class="token punctuation">:</span>
|
||
<span class="token punctuation">-</span> <span class="token string">"true"</span>
|
||
|
||
<span class="token key atrule">deployment</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">website</span><span class="token punctuation">:</span>
|
||
<span class="token key atrule">branch</span><span class="token punctuation">:</span> master
|
||
<span class="token key atrule">commands</span><span class="token punctuation">:</span>
|
||
<span class="token punctuation">-</span> git config <span class="token punctuation">-</span><span class="token punctuation">-</span>global user.email "test<span class="token punctuation">-</span>site<span class="token punctuation">-</span>bot@users.noreply.github.com"
|
||
<span class="token punctuation">-</span> git config <span class="token punctuation">-</span><span class="token punctuation">-</span>global user.name "Website Deployment Script"
|
||
<span class="token punctuation">-</span> echo "machine github.com login test<span class="token punctuation">-</span>site<span class="token punctuation">-</span>bot password $GITHUB_TOKEN" <span class="token punctuation">></span> ~/.netrc
|
||
<span class="token punctuation">-</span> cd website && npm install && GIT_USER=test<span class="token punctuation">-</span>site<span class="token punctuation">-</span>bot npm run publish<span class="token punctuation">-</span>gh<span class="token punctuation">-</span>pages</pre><p>Note that in this case a GitHub user <code>test-site-bot</code> is created to use just for publishing. Make sure to give your Git user push permissions for your project and to set a GITHUB_TOKEN environment variable in Circle.</p><p>If you wish to manually publish your website with the <code>publish-gh-pages</code> script, run the following example command with the appropriate variables for your project:</p><pre class="prism language-javascript">DEPLOY_USER<span class="token operator">=</span>deltice GIT_USER<span class="token operator">=</span>test<span class="token operator">-</span>site<span class="token operator">-</span>bot CIRCLE_PROJECT_USERNAME<span class="token operator">=</span>deltice CIRCLE_PROJECT_REPONAME<span class="token operator">=</span>test<span class="token operator">-</span>site CIRCLE_BRANCH<span class="token operator">=</span>master npm run publish<span class="token operator">-</span>gh<span class="token operator">-</span>pages</pre><h2><a class="anchor" name="manually-publishing-your-website"></a>Manually Publishing Your Website <a class="hash-link" href="#manually-publishing-your-website">#</a></h2><p>Docusaurus can generate all related HTML, JavaScript, CSS, and image assets.</p><p>Run the command:</p><p><code>yarn run build</code></p><p>All corresponding files will be placed in a <code>build</code> folder inside your Docusaurus project folder.</p><p>From here you can copy the folder, or write a script to deploy where you wish.</p></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="site-creation.html#content">← Previous</a><a class="docs-next button" href="publishing.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"><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> |