diff --git a/docs/en/publishing.html b/docs/en/publishing.html index 50a8f6f1a1..b5550e203d 100644 --- a/docs/en/publishing.html +++ b/docs/en/publishing.html @@ -28,7 +28,10 @@
  • projectName: The 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".
    • -

    While we recommend setting the above in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

    +

    Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

    +
    +
    +

    While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

    One of the required parameters is set as a environment variable:

    -
    -

    Docusaurus also supports deploying user or organization sites. Just set your project name to "username.github.io" (where username is your username or organization name on GitHub) and the publish script will automatically deploy your site to the root of the master branch instead.

    -

    Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

    To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

    GIT_USER=<GIT_USER> \