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

Deploy website

Browse source 
Deploy website version based on 0925895d3b
This commit is contained in:
Website Deployment Script 2018-03-16 21:08:21 +00:00
parent 0925895d3b
commit 305f8fd823
2 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/en/installation.html
View file

@ -14,6 +14,9 @@
<li><p><code>yarn global add docusaurus-init</code> or <code>npm install --global docusaurus-init</code></p></li>
<li><p><code>docusaurus-init</code></p></li>
</ol>
<blockquote>
<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>npm list docusaurus</code>. You can update to the <a href="https://www.npmjs.com/package/docusaurus">latest version</a> of Docusaurus by typeing <code>npm update</code>.</p>
</blockquote>
<p>Along with previously existing files and directories, your root directory will now contain a structure similar to:</p>
<pre><code class="hljs css bash">root-of-repo
├── docs-examples-from-docusaurus

12
docs/en/publishing.html
View file

@ -68,7 +68,16 @@
<li>Create a <code>.circleci</code> folder and create a <code>config.yml</code> under that folder.</li>
<li>Copy the text below into <code>.circleci/config.yml</code>.</li>
</ol>
<pre><code class="hljs css yml"><span class="hljs-attr">version:</span> <span class="hljs-number">2</span>
<pre><code class="hljs css yml"><span class="hljs-comment"># If you only one circle to run on direct commits to master, you can uncomment this out</span>
<span class="hljs-comment"># and uncomment the filters: *filter-only-master down below too</span>
<span class="hljs-comment">#</span>
<span class="hljs-comment"># aliases:</span>
<span class="hljs-comment"># - &amp;filter-only-master</span>
<span class="hljs-comment"># branches:</span>
<span class="hljs-comment"># only:</span>
<span class="hljs-comment"># - master</span>
<span class="hljs-attr">version:</span> <span class="hljs-number">2</span>
<span class="hljs-attr">jobs:</span>
<span class="hljs-attr"> deploy-website:</span>
<span class="hljs-attr"> docker:</span>
@ -90,6 +99,7 @@
<span class="hljs-attr"> build_and_deploy:</span>
<span class="hljs-attr"> jobs:</span>
<span class="hljs-bullet"> -</span> <span class="hljs-string">deploy-website</span>
<span class="hljs-comment"># filters: *filter-only-master </span>
</code></pre>
<p>Make sure to replace all <code>&lt;....&gt;</code> in the <code>command:</code> sequence with appropriate values. For <code>&lt;GIT_USER&gt;</code>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <code>&lt;GIT_USER&gt;</code> and <code>&lt;GITHUB_USERNAME&gt;</code> will be the same.</p>
<p><strong>DO NOT</strong> place the actual value of <code>$GITHUB_TOKEN</code> in <code>circle.yml</code>. We already configured that as an environment variable back in Step 3.</p>