3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-31 18:07:00 +02:00
Code Issues Projects Releases Packages Wiki Activity

Deploy website

Browse source 
Deploy website version based on 4f24876073
This commit is contained in:
Website Deployment Script 2017-11-17 22:27:34 +00:00
parent 4f24876073
commit ec5c47dc4b
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/en/publishing.html
View file

@ -26,9 +26,12 @@
<li><code>CIRCLE_PROJECT_USERNAME</code>: The GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the &quot;facebookexperimental&quot; GitHub organization.</li>
<li><code>CIRCLE_PROJECT_REPONAME</code>: The name of the GitHub repository for your project. For example, Docusaurus is hosted at <a href="https://github.com/facebookexperimental/docusaurus">https://github.com/facebookexperimental/docusaurus</a>, so our repo name in this case would be &quot;docusaurus&quot;.</li>
<li><code>GIT_USER</code>: The username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.</li>
<li><code>CIRCLE_BRANCH</code>: The branch that contains the latest docs changes that will be deployed. Usually, &quot;master&quot;.</li>
<li><code>CIRCLE_BRANCH</code>: The branch that contains the latest docs changes that will be deployed. Usually, the branch will be <code>master</code>, but it could be any branch (default or otherwise) except for <code>gh-pages</code>.</li>
</ul>
<blockquote>
<p>We currently require the published documentation to be served from the <code>gh-pages</code> branch in your GitHub repo.</p>
</blockquote>
<blockquote>
<p>The reason we prefix some of these parameters with <code>CIRCLE</code> is because Docusaurus recommends publishing your documentation continuously when changes are committed via <a href="https://circleci.org">CircleCI</a>.</p>
</blockquote>
<p>Once you have the paremeter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:</p>