diff --git a/docs/en/next/publishing.html b/docs/en/next/publishing.html index 994c64618a..19bca3ce2f 100644 --- a/docs/en/next/publishing.html +++ b/docs/en/next/publishing.html @@ -77,7 +77,7 @@

Even if your repository is private, anything published to a gh-pages branch will be public.

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

+

The following parameters need to be set in the siteConfig.js:

@@ -85,6 +85,8 @@ + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
@@ -247,7 +249,7 @@ For user or org sites, the publish script will deploy these sites to the root of

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
Last updated: 2018-6-14 23:03:37
PreviousNext

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

-

Two of the required parameters are set in the siteConfig.js:

+

The following parameters need to be set in the siteConfig.js:

@@ -85,6 +85,8 @@ + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
@@ -247,7 +249,7 @@ For user or org sites, the publish script will deploy these sites to the root of

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

-
Last updated: 2018-6-14 23:03:37
PreviousNext