mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-17 19:16:58 +02:00
Website Deployment Script
parent
d98939027f
commit
65cab4452c
724 changed files with 63919 additions and 2147 deletions
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html><html lang="ko"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Publish the Site · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage" />"/><meta name="docsearch:version" content="1.12.0"/><meta name="docsearch:language" content="ko"/><meta property="og:title" content="Publish the Site · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="<img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage" />"/><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>
|
||||
<!DOCTYPE html><html lang="ko"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Publish the Site · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage" />"/><meta name="docsearch:version" content="1.13.0"/><meta name="docsearch:language" content="ko"/><meta property="og:title" content="Publish the Site · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="<img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage" />"/><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>
|
||||
(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)
|
||||
|
|
@ -12,7 +12,7 @@
|
|||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/ko"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/ko/versions"><h3>1.12.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/ko/installation" target="_self">Docs</a></li><li class="siteNavGroupActive"><a href="/docs/ko/tutorial-setup" target="_self">Tutorial</a></li><li class=""><a href="/ko/users" target="_self">사용자</a></li><li class=""><a href="/blog/" target="_self">블로그</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>한국어</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/tutorial-publish-site">English</a></li><li><a href="/docs/fr/tutorial-publish-site">Français</a></li><li><a href="/docs/pt-BR/tutorial-publish-site">Português (Brasil)</a></li><li><a href="/docs/ro/tutorial-publish-site">Română</a></li><li><a href="/docs/ru/tutorial-publish-site">Русский</a></li><li><a href="/docs/zh-CN/tutorial-publish-site">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">번역을 도와주세요</a></li></ul></div></li><script>
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/ko"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/ko/versions"><h3>1.13.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/ko/installation" target="_self">Docs</a></li><li class="siteNavGroupActive"><a href="/docs/ko/tutorial-setup" target="_self">Tutorial</a></li><li class=""><a href="/ko/users" target="_self">사용자</a></li><li class=""><a href="/blog/" target="_self">블로그</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>한국어</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/tutorial-publish-site">English</a></li><li><a href="/docs/fr/tutorial-publish-site">Français</a></li><li><a href="/docs/pt-BR/tutorial-publish-site">Português (Brasil)</a></li><li><a href="/docs/ro/tutorial-publish-site">Română</a></li><li><a href="/docs/ru/tutorial-publish-site">Русский</a></li><li><a href="/docs/zh-CN/tutorial-publish-site">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">번역을 도와주세요</a></li></ul></div></li><script>
|
||||
const languagesMenuItem = document.getElementById("languages-menu");
|
||||
const languagesDropDown = document.getElementById("languages-dropdown");
|
||||
languagesMenuItem.addEventListener("click", function(event) {
|
||||
|
|
@ -81,27 +81,31 @@
|
|||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/ko" target="_blank" rel="noreferrer noopener">Translate</a><h1 class="postHeaderTitle">Publish the Site</h1></header><article><div><span><p><img alt="Docusaurus Facebook" src="/img/undraw_docusaurus_fb.svg" class="docImage" /></p>
|
||||
<p>Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.</p>
|
||||
<p>Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="put-the-site-online"></a><a href="#put-the-site-online" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" 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>Put the Site Online</h2>
|
||||
<p>Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.</p>
|
||||
<p>In <code>website/siteConfig.js</code>, fill in the following fields:</p>
|
||||
<pre><code class="hljs">const siteConfig = {
|
||||
...
|
||||
url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
|
||||
baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
|
||||
projectName: 'docusaurus-tutorial', // The name of your GitHub project. Same as above.
|
||||
organizationName: 'USERNAME' // Your GitHub username.
|
||||
...
|
||||
}
|
||||
</code></pre>
|
||||
<ol start="2">
|
||||
<li><p>In the <code>website</code> directory, run <code>npm run build</code> or <code>yarn build</code>. 명령어가 실행되면 <code>build</code> 디렉토리가 <code>website</code> 디렉토리 아래 생성됩니다. 생성된 디렉토리에는 작성한 문서가 <code>.html</code> 파일로 생성되며 <code>pages</code> 디렉토리 안에 있던 콘텐츠도 같이 생성됩니다. Make sure the <code>build</code> directory is there before running the next step.</p></li>
|
||||
<li><p>Replace <code><GIT_USER></code> with your GitHub username and run the following command.</p>
|
||||
<p>$ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages</p></li>
|
||||
<ol>
|
||||
<li><p>Edit the file <code>docusaurus-tutorial/website/siteConfig.js</code> and fill in the following values:</p>
|
||||
<p>const siteConfig = {
|
||||
...
|
||||
url: '<a href="https://USERNAME.github.io">https://USERNAME.github.io</a>', // Replace USERNAME with your GitHub username.
|
||||
baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
|
||||
projectName: 'docusaurus-tutorial', // The name of your GitHub project. Same as above.
|
||||
organizationName: 'USERNAME' // Your GitHub username.
|
||||
...
|
||||
}</p></li>
|
||||
</ol>
|
||||
<p>The built code will be pushed to the <code>gh-pages</code> branch of your repository.</p>
|
||||
<ol start="4">
|
||||
<li>Go to <code>https://USERNAME.github.io/docusaurus-tutorial/</code> and view your site in action!</li>
|
||||
<ol start="2">
|
||||
<li>In Terminal or Git Bash, kill the web server by pressing <strong>Cmd+C</strong> or <strong>Ctrl+C</strong>.</li>
|
||||
<li>In the <code>website</code> directory, run <code>npm run build</code> or <code>yarn build</code>. The command generates a <code>build</code> directory inside the <code>website</code> directory, containing HTML files (and other file types) for all of your docs and other pages. Make sure the <code>docusaurus-tutorial/website/build</code> directory is successfully created before running the next step.</li>
|
||||
<li>Replace <code>USERNAME</code> with your GitHub username and run the following command.</li>
|
||||
</ol>
|
||||
<pre><code class="hljs css language-sh">GIT_USER=USERNAME CURRENT_BRANCH=master USE_SSH=<span class="hljs-literal">true</span> npm run publish-gh-pages <span class="hljs-comment"># SSH</span>
|
||||
<span class="hljs-comment"># or</span>
|
||||
GIT_USER=USERNAME CURRENT_BRANCH=master npm run publish-gh-pages <span class="hljs-comment"># HTTPS</span>
|
||||
</code></pre>
|
||||
<p>The HTML files (and other file types) are pushed to the <code>gh-pages</code> branch of your repository: <a href="https://github.com/USERNAME/docusaurus-tutorial">https://github.com/USERNAME/docusaurus-tutorial</a>.</p>
|
||||
<ol start="5">
|
||||
<li>Go to <a href="https://USERNAME.github.io/docusaurus-tutorial/">https://USERNAME.github.io/docusaurus-tutorial/</a> and view your site in action!</li>
|
||||
</ol>
|
||||
<blockquote>
|
||||
<p>Note that when you run <code>npm run start</code> again, the <code>baseUrl</code> will now be part of the path.</p>
|
||||
|
|
@ -128,6 +132,6 @@
|
|||
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
|
||||
indexName: 'docusaurus',
|
||||
inputSelector: '#search_input_react',
|
||||
algoliaOptions: {"facetFilters":["language:ko","version:1.12.0"]}
|
||||
algoliaOptions: {"facetFilters":["language:ko","version:1.13.0"]}
|
||||
});
|
||||
</script></body></html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue