diff --git a/css/main.css b/css/main.css index 12cc226041..1e26e685fb 100644 --- a/css/main.css +++ b/css/main.css @@ -1893,3 +1893,7 @@ footer .copyright { .testimonials img { border-radius: 50%; } + +table td:first-child > code { + white-space: nowrap; +} diff --git a/docs/en/next/publishing.html b/docs/en/next/publishing.html index 398975d9ca..05be886145 100644 --- a/docs/en/next/publishing.html +++ b/docs/en/next/publishing.html @@ -21,7 +21,7 @@

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

Hosting Static HTML Pages

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's "html" directory.

+

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

@@ -33,10 +33,15 @@

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](/docs/en/next/configuración del sitio.html):

- + + + + + + + + +
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".

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.

@@ -44,14 +49,24 @@

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:

- + + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.

There are also two optional parameters that are set as environment variables:

- + + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.

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> \
@@ -109,7 +124,7 @@
   build_and_deploy:
     jobs:
       - deploy-website:
-#         filters: *filter-only-master   
+#         filters: *filter-only-master

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

diff --git a/docs/es-ES/next/publishing.html b/docs/es-ES/next/publishing.html index b8e303f2b8..a920ceef28 100644 --- a/docs/es-ES/next/publishing.html +++ b/docs/es-ES/next/publishing.html @@ -21,7 +21,7 @@

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

Hosting Static HTML Pages

-

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's "html" directory.

+

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

@@ -33,23 +33,38 @@

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](/docs/es-ES/next/configuración del sitio.html):

- + + + + + + + + +
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".

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:

- + + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.

There are also two optional parameters that are set as environment variables:

- + + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.

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> \
@@ -107,7 +122,7 @@
   build_and_deploy:
     jobs:
       - deploy-website:
-#         filters: *filter-only-master   
+#         filters: *filter-only-master

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.