From 3a62f53a2be6173a3626e5dd153e5899c36e276f Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Thu, 1 Oct 2020 15:31:57 +0000 Subject: [PATCH] Deploy website Deploy website version based on 41ff9a9fd03a38b9fb11faa44612e5e988ffe15c --- docs/en/1.10.x/adding-blog.html | 2 +- docs/en/1.10.x/adding-blog/index.html | 2 +- docs/en/1.10.x/api-pages.html | 2 +- docs/en/1.10.x/api-pages/index.html | 2 +- docs/en/1.10.x/commands.html | 2 +- docs/en/1.10.x/commands/index.html | 2 +- docs/en/1.10.x/custom-pages.html | 2 +- docs/en/1.10.x/custom-pages/index.html | 2 +- docs/en/1.10.x/doc-markdown.html | 2 +- docs/en/1.10.x/doc-markdown/index.html | 2 +- docs/en/1.10.x/docker.html | 2 +- docs/en/1.10.x/docker/index.html | 2 +- docs/en/1.10.x/installation.html | 2 +- docs/en/1.10.x/installation/index.html | 2 +- docs/en/1.10.x/navigation.html | 2 +- docs/en/1.10.x/navigation/index.html | 2 +- docs/en/1.10.x/publishing.html | 2 +- docs/en/1.10.x/publishing/index.html | 2 +- docs/en/1.10.x/search.html | 2 +- docs/en/1.10.x/search/index.html | 2 +- docs/en/1.10.x/site-config.html | 2 +- docs/en/1.10.x/site-config/index.html | 2 +- docs/en/1.10.x/site-creation.html | 2 +- docs/en/1.10.x/site-creation/index.html | 2 +- docs/en/1.10.x/site-preparation.html | 2 +- docs/en/1.10.x/site-preparation/index.html | 2 +- docs/en/1.10.x/translation.html | 2 +- docs/en/1.10.x/translation/index.html | 2 +- docs/en/1.10.x/tutorial-create-new-site.html | 2 +- docs/en/1.10.x/tutorial-create-new-site/index.html | 2 +- docs/en/1.10.x/tutorial-create-pages.html | 2 +- docs/en/1.10.x/tutorial-create-pages/index.html | 2 +- docs/en/1.10.x/tutorial-publish-site.html | 2 +- docs/en/1.10.x/tutorial-publish-site/index.html | 2 +- docs/en/1.10.x/tutorial-setup.html | 2 +- docs/en/1.10.x/tutorial-setup/index.html | 2 +- docs/en/1.10.x/tutorial-version.html | 2 +- docs/en/1.10.x/tutorial-version/index.html | 2 +- docs/en/1.10.x/versioning.html | 2 +- docs/en/1.10.x/versioning/index.html | 2 +- docs/en/1.11.x/adding-blog.html | 2 +- docs/en/1.11.x/adding-blog/index.html | 2 +- docs/en/1.11.x/api-pages.html | 2 +- docs/en/1.11.x/api-pages/index.html | 2 +- docs/en/1.11.x/commands.html | 2 +- docs/en/1.11.x/commands/index.html | 2 +- docs/en/1.11.x/custom-pages.html | 2 +- docs/en/1.11.x/custom-pages/index.html | 2 +- docs/en/1.11.x/doc-markdown.html | 2 +- docs/en/1.11.x/doc-markdown/index.html | 2 +- docs/en/1.11.x/docker.html | 2 +- docs/en/1.11.x/docker/index.html | 2 +- docs/en/1.11.x/installation.html | 2 +- docs/en/1.11.x/installation/index.html | 2 +- docs/en/1.11.x/navigation.html | 2 +- docs/en/1.11.x/navigation/index.html | 2 +- docs/en/1.11.x/publishing.html | 2 +- docs/en/1.11.x/publishing/index.html | 2 +- docs/en/1.11.x/search.html | 2 +- docs/en/1.11.x/search/index.html | 2 +- docs/en/1.11.x/site-config.html | 2 +- docs/en/1.11.x/site-config/index.html | 2 +- docs/en/1.11.x/site-creation.html | 2 +- docs/en/1.11.x/site-creation/index.html | 2 +- docs/en/1.11.x/site-preparation.html | 2 +- docs/en/1.11.x/site-preparation/index.html | 2 +- docs/en/1.11.x/translation.html | 2 +- docs/en/1.11.x/translation/index.html | 2 +- docs/en/1.11.x/tutorial-create-new-site.html | 2 +- docs/en/1.11.x/tutorial-create-new-site/index.html | 2 +- docs/en/1.11.x/tutorial-create-pages.html | 2 +- docs/en/1.11.x/tutorial-create-pages/index.html | 2 +- docs/en/1.11.x/tutorial-publish-site.html | 2 +- docs/en/1.11.x/tutorial-publish-site/index.html | 2 +- docs/en/1.11.x/tutorial-setup.html | 2 +- docs/en/1.11.x/tutorial-setup/index.html | 2 +- docs/en/1.11.x/tutorial-version.html | 2 +- docs/en/1.11.x/tutorial-version/index.html | 2 +- docs/en/1.11.x/versioning.html | 2 +- docs/en/1.11.x/versioning/index.html | 2 +- docs/en/1.12.0/adding-blog.html | 2 +- docs/en/1.12.0/adding-blog/index.html | 2 +- docs/en/1.12.0/api-pages.html | 2 +- docs/en/1.12.0/api-pages/index.html | 2 +- docs/en/1.12.0/commands.html | 2 +- docs/en/1.12.0/commands/index.html | 2 +- docs/en/1.12.0/custom-pages.html | 2 +- docs/en/1.12.0/custom-pages/index.html | 2 +- docs/en/1.12.0/doc-markdown.html | 2 +- docs/en/1.12.0/doc-markdown/index.html | 2 +- docs/en/1.12.0/docker.html | 2 +- docs/en/1.12.0/docker/index.html | 2 +- docs/en/1.12.0/installation.html | 2 +- docs/en/1.12.0/installation/index.html | 2 +- docs/en/1.12.0/navigation.html | 2 +- docs/en/1.12.0/navigation/index.html | 2 +- docs/en/1.12.0/publishing.html | 2 +- docs/en/1.12.0/publishing/index.html | 2 +- docs/en/1.12.0/search.html | 2 +- docs/en/1.12.0/search/index.html | 2 +- docs/en/1.12.0/site-config.html | 2 +- docs/en/1.12.0/site-config/index.html | 2 +- docs/en/1.12.0/site-creation.html | 2 +- docs/en/1.12.0/site-creation/index.html | 2 +- docs/en/1.12.0/site-preparation.html | 2 +- docs/en/1.12.0/site-preparation/index.html | 2 +- docs/en/1.12.0/translation.html | 2 +- docs/en/1.12.0/translation/index.html | 2 +- docs/en/1.12.0/tutorial-create-new-site.html | 2 +- docs/en/1.12.0/tutorial-create-new-site/index.html | 2 +- docs/en/1.12.0/tutorial-create-pages.html | 2 +- docs/en/1.12.0/tutorial-create-pages/index.html | 2 +- docs/en/1.12.0/tutorial-publish-site.html | 2 +- docs/en/1.12.0/tutorial-publish-site/index.html | 2 +- docs/en/1.12.0/tutorial-setup.html | 2 +- docs/en/1.12.0/tutorial-setup/index.html | 2 +- docs/en/1.12.0/tutorial-version.html | 2 +- docs/en/1.12.0/tutorial-version/index.html | 2 +- docs/en/1.12.0/versioning.html | 2 +- docs/en/1.12.0/versioning/index.html | 2 +- docs/en/1.13.0/adding-blog.html | 2 +- docs/en/1.13.0/adding-blog/index.html | 2 +- docs/en/1.13.0/api-pages.html | 2 +- docs/en/1.13.0/api-pages/index.html | 2 +- docs/en/1.13.0/commands.html | 2 +- docs/en/1.13.0/commands/index.html | 2 +- docs/en/1.13.0/custom-pages.html | 2 +- docs/en/1.13.0/custom-pages/index.html | 2 +- docs/en/1.13.0/doc-markdown.html | 2 +- docs/en/1.13.0/doc-markdown/index.html | 2 +- docs/en/1.13.0/docker.html | 2 +- docs/en/1.13.0/docker/index.html | 2 +- docs/en/1.13.0/installation.html | 2 +- docs/en/1.13.0/installation/index.html | 2 +- docs/en/1.13.0/navigation.html | 2 +- docs/en/1.13.0/navigation/index.html | 2 +- docs/en/1.13.0/publishing.html | 2 +- docs/en/1.13.0/publishing/index.html | 2 +- docs/en/1.13.0/search.html | 2 +- docs/en/1.13.0/search/index.html | 2 +- docs/en/1.13.0/site-config.html | 2 +- docs/en/1.13.0/site-config/index.html | 2 +- docs/en/1.13.0/site-creation.html | 2 +- docs/en/1.13.0/site-creation/index.html | 2 +- docs/en/1.13.0/site-preparation.html | 2 +- docs/en/1.13.0/site-preparation/index.html | 2 +- docs/en/1.13.0/translation.html | 2 +- docs/en/1.13.0/translation/index.html | 2 +- docs/en/1.13.0/tutorial-create-new-site.html | 2 +- docs/en/1.13.0/tutorial-create-new-site/index.html | 2 +- docs/en/1.13.0/tutorial-create-pages.html | 2 +- docs/en/1.13.0/tutorial-create-pages/index.html | 2 +- docs/en/1.13.0/tutorial-publish-site.html | 2 +- docs/en/1.13.0/tutorial-publish-site/index.html | 2 +- docs/en/1.13.0/tutorial-setup.html | 2 +- docs/en/1.13.0/tutorial-setup/index.html | 2 +- docs/en/1.13.0/tutorial-version.html | 2 +- docs/en/1.13.0/tutorial-version/index.html | 2 +- docs/en/1.13.0/versioning.html | 2 +- docs/en/1.13.0/versioning/index.html | 2 +- docs/en/1.14.4/adding-blog.html | 2 +- docs/en/1.14.4/adding-blog/index.html | 2 +- docs/en/1.14.4/api-pages.html | 2 +- docs/en/1.14.4/api-pages/index.html | 2 +- docs/en/1.14.4/commands.html | 2 +- docs/en/1.14.4/commands/index.html | 2 +- docs/en/1.14.4/custom-pages.html | 2 +- docs/en/1.14.4/custom-pages/index.html | 2 +- docs/en/1.14.4/doc-markdown.html | 2 +- docs/en/1.14.4/doc-markdown/index.html | 2 +- docs/en/1.14.4/docker.html | 2 +- docs/en/1.14.4/docker/index.html | 2 +- docs/en/1.14.4/installation.html | 2 +- docs/en/1.14.4/installation/index.html | 2 +- docs/en/1.14.4/navigation.html | 2 +- docs/en/1.14.4/navigation/index.html | 2 +- docs/en/1.14.4/publishing.html | 2 +- docs/en/1.14.4/publishing/index.html | 2 +- docs/en/1.14.4/search.html | 2 +- docs/en/1.14.4/search/index.html | 2 +- docs/en/1.14.4/site-config.html | 2 +- docs/en/1.14.4/site-config/index.html | 2 +- docs/en/1.14.4/site-creation.html | 2 +- docs/en/1.14.4/site-creation/index.html | 2 +- docs/en/1.14.4/site-preparation.html | 2 +- docs/en/1.14.4/site-preparation/index.html | 2 +- docs/en/1.14.4/translation.html | 2 +- docs/en/1.14.4/translation/index.html | 2 +- docs/en/1.14.4/tutorial-create-new-site.html | 2 +- docs/en/1.14.4/tutorial-create-new-site/index.html | 2 +- docs/en/1.14.4/tutorial-create-pages.html | 2 +- docs/en/1.14.4/tutorial-create-pages/index.html | 2 +- docs/en/1.14.4/tutorial-publish-site.html | 2 +- docs/en/1.14.4/tutorial-publish-site/index.html | 2 +- docs/en/1.14.4/tutorial-setup.html | 2 +- docs/en/1.14.4/tutorial-setup/index.html | 2 +- docs/en/1.14.4/tutorial-version.html | 2 +- docs/en/1.14.4/tutorial-version/index.html | 2 +- docs/en/1.14.4/versioning.html | 2 +- docs/en/1.14.4/versioning/index.html | 2 +- docs/en/1.14.5/adding-blog.html | 2 +- docs/en/1.14.5/adding-blog/index.html | 2 +- docs/en/1.14.5/api-pages.html | 2 +- docs/en/1.14.5/api-pages/index.html | 2 +- docs/en/1.14.5/commands.html | 2 +- docs/en/1.14.5/commands/index.html | 2 +- docs/en/1.14.5/custom-pages.html | 2 +- docs/en/1.14.5/custom-pages/index.html | 2 +- docs/en/1.14.5/doc-markdown.html | 2 +- docs/en/1.14.5/doc-markdown/index.html | 2 +- docs/en/1.14.5/docker.html | 2 +- docs/en/1.14.5/docker/index.html | 2 +- docs/en/1.14.5/installation.html | 2 +- docs/en/1.14.5/installation/index.html | 2 +- docs/en/1.14.5/navigation.html | 2 +- docs/en/1.14.5/navigation/index.html | 2 +- docs/en/1.14.5/publishing.html | 2 +- docs/en/1.14.5/publishing/index.html | 2 +- docs/en/1.14.5/search.html | 2 +- docs/en/1.14.5/search/index.html | 2 +- docs/en/1.14.5/site-config.html | 2 +- docs/en/1.14.5/site-config/index.html | 2 +- docs/en/1.14.5/site-creation.html | 2 +- docs/en/1.14.5/site-creation/index.html | 2 +- docs/en/1.14.5/site-preparation.html | 2 +- docs/en/1.14.5/site-preparation/index.html | 2 +- docs/en/1.14.5/translation.html | 2 +- docs/en/1.14.5/translation/index.html | 2 +- docs/en/1.14.5/tutorial-create-new-site.html | 2 +- docs/en/1.14.5/tutorial-create-new-site/index.html | 2 +- docs/en/1.14.5/tutorial-create-pages.html | 2 +- docs/en/1.14.5/tutorial-create-pages/index.html | 2 +- docs/en/1.14.5/tutorial-publish-site.html | 2 +- docs/en/1.14.5/tutorial-publish-site/index.html | 2 +- docs/en/1.14.5/tutorial-setup.html | 2 +- docs/en/1.14.5/tutorial-setup/index.html | 2 +- docs/en/1.14.5/tutorial-version.html | 2 +- docs/en/1.14.5/tutorial-version/index.html | 2 +- docs/en/1.14.5/versioning.html | 2 +- docs/en/1.14.5/versioning/index.html | 2 +- docs/en/1.9.x/adding-blog.html | 2 +- docs/en/1.9.x/adding-blog/index.html | 2 +- docs/en/1.9.x/api-pages.html | 2 +- docs/en/1.9.x/api-pages/index.html | 2 +- docs/en/1.9.x/commands.html | 2 +- docs/en/1.9.x/commands/index.html | 2 +- docs/en/1.9.x/custom-pages.html | 2 +- docs/en/1.9.x/custom-pages/index.html | 2 +- docs/en/1.9.x/doc-markdown.html | 2 +- docs/en/1.9.x/doc-markdown/index.html | 2 +- docs/en/1.9.x/docker.html | 2 +- docs/en/1.9.x/docker/index.html | 2 +- docs/en/1.9.x/installation.html | 2 +- docs/en/1.9.x/installation/index.html | 2 +- docs/en/1.9.x/navigation.html | 2 +- docs/en/1.9.x/navigation/index.html | 2 +- docs/en/1.9.x/publishing.html | 2 +- docs/en/1.9.x/publishing/index.html | 2 +- docs/en/1.9.x/search.html | 2 +- docs/en/1.9.x/search/index.html | 2 +- docs/en/1.9.x/site-config.html | 2 +- docs/en/1.9.x/site-config/index.html | 2 +- docs/en/1.9.x/site-creation.html | 2 +- docs/en/1.9.x/site-creation/index.html | 2 +- docs/en/1.9.x/site-preparation.html | 2 +- docs/en/1.9.x/site-preparation/index.html | 2 +- docs/en/1.9.x/translation.html | 2 +- docs/en/1.9.x/translation/index.html | 2 +- docs/en/1.9.x/tutorial-create-new-site.html | 2 +- docs/en/1.9.x/tutorial-create-new-site/index.html | 2 +- docs/en/1.9.x/tutorial-create-pages.html | 2 +- docs/en/1.9.x/tutorial-create-pages/index.html | 2 +- docs/en/1.9.x/tutorial-publish-site.html | 2 +- docs/en/1.9.x/tutorial-publish-site/index.html | 2 +- docs/en/1.9.x/tutorial-setup.html | 2 +- docs/en/1.9.x/tutorial-setup/index.html | 2 +- docs/en/1.9.x/tutorial-version.html | 2 +- docs/en/1.9.x/tutorial-version/index.html | 2 +- docs/en/1.9.x/versioning.html | 2 +- docs/en/1.9.x/versioning/index.html | 2 +- docs/en/adding-blog.html | 2 +- docs/en/adding-blog/index.html | 2 +- docs/en/api-pages.html | 2 +- docs/en/api-pages/index.html | 2 +- docs/en/commands.html | 2 +- docs/en/commands/index.html | 2 +- docs/en/custom-pages.html | 2 +- docs/en/custom-pages/index.html | 2 +- docs/en/doc-markdown.html | 2 +- docs/en/doc-markdown/index.html | 2 +- docs/en/docker.html | 2 +- docs/en/docker/index.html | 2 +- docs/en/installation.html | 2 +- docs/en/installation/index.html | 2 +- docs/en/navigation.html | 2 +- docs/en/navigation/index.html | 2 +- docs/en/next/adding-blog.html | 2 +- docs/en/next/adding-blog/index.html | 2 +- docs/en/next/api-pages.html | 2 +- docs/en/next/api-pages/index.html | 2 +- docs/en/next/commands.html | 2 +- docs/en/next/commands/index.html | 2 +- docs/en/next/custom-pages.html | 2 +- docs/en/next/custom-pages/index.html | 2 +- docs/en/next/doc-markdown.html | 2 +- docs/en/next/doc-markdown/index.html | 2 +- docs/en/next/docker.html | 2 +- docs/en/next/docker/index.html | 2 +- docs/en/next/installation.html | 2 +- docs/en/next/installation/index.html | 2 +- docs/en/next/navigation.html | 2 +- docs/en/next/navigation/index.html | 2 +- docs/en/next/publishing.html | 2 +- docs/en/next/publishing/index.html | 2 +- docs/en/next/search.html | 2 +- docs/en/next/search/index.html | 2 +- docs/en/next/site-config.html | 2 +- docs/en/next/site-config/index.html | 2 +- docs/en/next/site-creation.html | 2 +- docs/en/next/site-creation/index.html | 2 +- docs/en/next/site-preparation.html | 2 +- docs/en/next/site-preparation/index.html | 2 +- docs/en/next/translation.html | 2 +- docs/en/next/translation/index.html | 2 +- docs/en/next/tutorial-create-new-site.html | 2 +- docs/en/next/tutorial-create-new-site/index.html | 2 +- docs/en/next/tutorial-create-pages.html | 2 +- docs/en/next/tutorial-create-pages/index.html | 2 +- docs/en/next/tutorial-publish-site.html | 2 +- docs/en/next/tutorial-publish-site/index.html | 2 +- docs/en/next/tutorial-setup.html | 2 +- docs/en/next/tutorial-setup/index.html | 2 +- docs/en/next/tutorial-version.html | 2 +- docs/en/next/tutorial-version/index.html | 2 +- docs/en/next/versioning.html | 2 +- docs/en/next/versioning/index.html | 2 +- docs/en/publishing.html | 2 +- docs/en/publishing/index.html | 2 +- docs/en/search.html | 2 +- docs/en/search/index.html | 2 +- docs/en/site-config.html | 2 +- docs/en/site-config/index.html | 2 +- docs/en/site-creation.html | 2 +- docs/en/site-creation/index.html | 2 +- docs/en/site-preparation.html | 2 +- docs/en/site-preparation/index.html | 2 +- docs/en/translation.html | 2 +- docs/en/translation/index.html | 2 +- docs/en/tutorial-create-new-site.html | 2 +- docs/en/tutorial-create-new-site/index.html | 2 +- docs/en/tutorial-create-pages.html | 2 +- docs/en/tutorial-create-pages/index.html | 2 +- docs/en/tutorial-publish-site.html | 2 +- docs/en/tutorial-publish-site/index.html | 2 +- docs/en/tutorial-setup.html | 2 +- docs/en/tutorial-setup/index.html | 2 +- docs/en/tutorial-version.html | 2 +- docs/en/tutorial-version/index.html | 2 +- docs/en/versioning.html | 2 +- docs/en/versioning/index.html | 2 +- 360 files changed, 360 insertions(+), 360 deletions(-) diff --git a/docs/en/1.10.x/adding-blog.html b/docs/en/1.10.x/adding-blog.html index 7dc976d238..5b4fd63e83 100644 --- a/docs/en/1.10.x/adding-blog.html +++ b/docs/en/1.10.x/adding-blog.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.10.x/adding-blog/index.html b/docs/en/1.10.x/adding-blog/index.html
index 7dc976d238..5b4fd63e83 100644
--- a/docs/en/1.10.x/adding-blog/index.html
+++ b/docs/en/1.10.x/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.10.x/api-pages.html b/docs/en/1.10.x/api-pages.html
index 1169ef6cec..dc34ed7f56 100644
--- a/docs/en/1.10.x/api-pages.html
+++ b/docs/en/1.10.x/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.10.x/api-pages/index.html b/docs/en/1.10.x/api-pages/index.html index 1169ef6cec..dc34ed7f56 100644 --- a/docs/en/1.10.x/api-pages/index.html +++ b/docs/en/1.10.x/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.10.x/commands.html b/docs/en/1.10.x/commands.html index 6a9841035e..bd2c99fdae 100644 --- a/docs/en/1.10.x/commands.html +++ b/docs/en/1.10.x/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.10.x/commands/index.html b/docs/en/1.10.x/commands/index.html index 6a9841035e..bd2c99fdae 100644 --- a/docs/en/1.10.x/commands/index.html +++ b/docs/en/1.10.x/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.10.x/custom-pages.html b/docs/en/1.10.x/custom-pages.html index 665980269e..6a5acf627c 100644 --- a/docs/en/1.10.x/custom-pages.html +++ b/docs/en/1.10.x/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.10.x/custom-pages/index.html b/docs/en/1.10.x/custom-pages/index.html index 665980269e..6a5acf627c 100644 --- a/docs/en/1.10.x/custom-pages/index.html +++ b/docs/en/1.10.x/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.10.x/doc-markdown.html b/docs/en/1.10.x/doc-markdown.html index faec0a9089..e1aad328ab 100644 --- a/docs/en/1.10.x/doc-markdown.html +++ b/docs/en/1.10.x/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.10.x/doc-markdown/index.html b/docs/en/1.10.x/doc-markdown/index.html index faec0a9089..e1aad328ab 100644 --- a/docs/en/1.10.x/doc-markdown/index.html +++ b/docs/en/1.10.x/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.10.x/docker.html b/docs/en/1.10.x/docker.html index e2c6dba877..ecc2999200 100644 --- a/docs/en/1.10.x/docker.html +++ b/docs/en/1.10.x/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.10.x/docker/index.html b/docs/en/1.10.x/docker/index.html index e2c6dba877..ecc2999200 100644 --- a/docs/en/1.10.x/docker/index.html +++ b/docs/en/1.10.x/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.10.x/installation.html b/docs/en/1.10.x/installation.html index dc1a1f9158..ff990d8534 100644 --- a/docs/en/1.10.x/installation.html +++ b/docs/en/1.10.x/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.10.x/installation/index.html b/docs/en/1.10.x/installation/index.html index dc1a1f9158..ff990d8534 100644 --- a/docs/en/1.10.x/installation/index.html +++ b/docs/en/1.10.x/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.10.x/navigation.html b/docs/en/1.10.x/navigation.html index 5e85f03be7..eb03b5c96a 100644 --- a/docs/en/1.10.x/navigation.html +++ b/docs/en/1.10.x/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.10.x/navigation/index.html b/docs/en/1.10.x/navigation/index.html
index 5e85f03be7..eb03b5c96a 100644
--- a/docs/en/1.10.x/navigation/index.html
+++ b/docs/en/1.10.x/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.10.x/publishing.html b/docs/en/1.10.x/publishing.html
index 8cc61e98c6..e06cd126ef 100644
--- a/docs/en/1.10.x/publishing.html
+++ b/docs/en/1.10.x/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.10.x/publishing/index.html b/docs/en/1.10.x/publishing/index.html
index 8cc61e98c6..e06cd126ef 100644
--- a/docs/en/1.10.x/publishing/index.html
+++ b/docs/en/1.10.x/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.10.x/search.html b/docs/en/1.10.x/search.html
index ad68ff2608..403e235d93 100644
--- a/docs/en/1.10.x/search.html
+++ b/docs/en/1.10.x/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.10.x/search/index.html b/docs/en/1.10.x/search/index.html index ad68ff2608..403e235d93 100644 --- a/docs/en/1.10.x/search/index.html +++ b/docs/en/1.10.x/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.10.x/site-config.html b/docs/en/1.10.x/site-config.html index 0429d8a37c..ada0dde4a8 100644 --- a/docs/en/1.10.x/site-config.html +++ b/docs/en/1.10.x/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.10.x/site-config/index.html b/docs/en/1.10.x/site-config/index.html index 0429d8a37c..ada0dde4a8 100644 --- a/docs/en/1.10.x/site-config/index.html +++ b/docs/en/1.10.x/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.10.x/site-creation.html b/docs/en/1.10.x/site-creation.html index bad6f2477b..c84185e2ac 100644 --- a/docs/en/1.10.x/site-creation.html +++ b/docs/en/1.10.x/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.10.x/site-creation/index.html b/docs/en/1.10.x/site-creation/index.html index bad6f2477b..c84185e2ac 100644 --- a/docs/en/1.10.x/site-creation/index.html +++ b/docs/en/1.10.x/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.10.x/site-preparation.html b/docs/en/1.10.x/site-preparation.html index 2fd1de27ee..e7292d93fc 100644 --- a/docs/en/1.10.x/site-preparation.html +++ b/docs/en/1.10.x/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.10.x/site-preparation/index.html b/docs/en/1.10.x/site-preparation/index.html
index 2fd1de27ee..e7292d93fc 100644
--- a/docs/en/1.10.x/site-preparation/index.html
+++ b/docs/en/1.10.x/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.10.x/translation.html b/docs/en/1.10.x/translation.html
index 74a5f64458..9509cf8bce 100644
--- a/docs/en/1.10.x/translation.html
+++ b/docs/en/1.10.x/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.10.x/translation/index.html b/docs/en/1.10.x/translation/index.html
index 74a5f64458..9509cf8bce 100644
--- a/docs/en/1.10.x/translation/index.html
+++ b/docs/en/1.10.x/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.10.x/tutorial-create-new-site.html b/docs/en/1.10.x/tutorial-create-new-site.html
index c2cb26d4c1..a566f5cedc 100644
--- a/docs/en/1.10.x/tutorial-create-new-site.html
+++ b/docs/en/1.10.x/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.10.x/tutorial-create-new-site/index.html b/docs/en/1.10.x/tutorial-create-new-site/index.html index c2cb26d4c1..a566f5cedc 100644 --- a/docs/en/1.10.x/tutorial-create-new-site/index.html +++ b/docs/en/1.10.x/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.10.x/tutorial-create-pages.html b/docs/en/1.10.x/tutorial-create-pages.html index 241c166aae..66fc7acc2e 100644 --- a/docs/en/1.10.x/tutorial-create-pages.html +++ b/docs/en/1.10.x/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.10.x/tutorial-create-pages/index.html b/docs/en/1.10.x/tutorial-create-pages/index.html index 241c166aae..66fc7acc2e 100644 --- a/docs/en/1.10.x/tutorial-create-pages/index.html +++ b/docs/en/1.10.x/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.10.x/tutorial-publish-site.html b/docs/en/1.10.x/tutorial-publish-site.html index f6569b489a..813163826c 100644 --- a/docs/en/1.10.x/tutorial-publish-site.html +++ b/docs/en/1.10.x/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.10.x/tutorial-publish-site/index.html b/docs/en/1.10.x/tutorial-publish-site/index.html index f6569b489a..813163826c 100644 --- a/docs/en/1.10.x/tutorial-publish-site/index.html +++ b/docs/en/1.10.x/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.10.x/tutorial-setup.html b/docs/en/1.10.x/tutorial-setup.html index 861d6922c3..34b7b83efe 100644 --- a/docs/en/1.10.x/tutorial-setup.html +++ b/docs/en/1.10.x/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.10.x/tutorial-setup/index.html b/docs/en/1.10.x/tutorial-setup/index.html index 861d6922c3..34b7b83efe 100644 --- a/docs/en/1.10.x/tutorial-setup/index.html +++ b/docs/en/1.10.x/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.10.x/tutorial-version.html b/docs/en/1.10.x/tutorial-version.html index 3776db47fc..5513ebc181 100644 --- a/docs/en/1.10.x/tutorial-version.html +++ b/docs/en/1.10.x/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.10.x/tutorial-version/index.html b/docs/en/1.10.x/tutorial-version/index.html index 3776db47fc..5513ebc181 100644 --- a/docs/en/1.10.x/tutorial-version/index.html +++ b/docs/en/1.10.x/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.10.x/versioning.html b/docs/en/1.10.x/versioning.html index ccc51218c1..4a7b1c54f2 100644 --- a/docs/en/1.10.x/versioning.html +++ b/docs/en/1.10.x/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.10.x/versioning/index.html b/docs/en/1.10.x/versioning/index.html
index ccc51218c1..4a7b1c54f2 100644
--- a/docs/en/1.10.x/versioning/index.html
+++ b/docs/en/1.10.x/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.11.x/adding-blog.html b/docs/en/1.11.x/adding-blog.html
index 555efb02c7..be3e179a6d 100644
--- a/docs/en/1.11.x/adding-blog.html
+++ b/docs/en/1.11.x/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.11.x/adding-blog/index.html b/docs/en/1.11.x/adding-blog/index.html
index 555efb02c7..be3e179a6d 100644
--- a/docs/en/1.11.x/adding-blog/index.html
+++ b/docs/en/1.11.x/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.11.x/api-pages.html b/docs/en/1.11.x/api-pages.html
index 8564c49fbe..bcd5d2de9d 100644
--- a/docs/en/1.11.x/api-pages.html
+++ b/docs/en/1.11.x/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.11.x/api-pages/index.html b/docs/en/1.11.x/api-pages/index.html index 8564c49fbe..bcd5d2de9d 100644 --- a/docs/en/1.11.x/api-pages/index.html +++ b/docs/en/1.11.x/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.11.x/commands.html b/docs/en/1.11.x/commands.html index d12a4e0919..7798dd5d34 100644 --- a/docs/en/1.11.x/commands.html +++ b/docs/en/1.11.x/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.11.x/commands/index.html b/docs/en/1.11.x/commands/index.html index d12a4e0919..7798dd5d34 100644 --- a/docs/en/1.11.x/commands/index.html +++ b/docs/en/1.11.x/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.11.x/custom-pages.html b/docs/en/1.11.x/custom-pages.html index 36a8adc8e3..0ab402b6f3 100644 --- a/docs/en/1.11.x/custom-pages.html +++ b/docs/en/1.11.x/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.11.x/custom-pages/index.html b/docs/en/1.11.x/custom-pages/index.html index 36a8adc8e3..0ab402b6f3 100644 --- a/docs/en/1.11.x/custom-pages/index.html +++ b/docs/en/1.11.x/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.11.x/doc-markdown.html b/docs/en/1.11.x/doc-markdown.html index f81259617d..3475622db5 100644 --- a/docs/en/1.11.x/doc-markdown.html +++ b/docs/en/1.11.x/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.11.x/doc-markdown/index.html b/docs/en/1.11.x/doc-markdown/index.html index f81259617d..3475622db5 100644 --- a/docs/en/1.11.x/doc-markdown/index.html +++ b/docs/en/1.11.x/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.11.x/docker.html b/docs/en/1.11.x/docker.html index 61d7504665..53d39c2ba6 100644 --- a/docs/en/1.11.x/docker.html +++ b/docs/en/1.11.x/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.11.x/docker/index.html b/docs/en/1.11.x/docker/index.html index 61d7504665..53d39c2ba6 100644 --- a/docs/en/1.11.x/docker/index.html +++ b/docs/en/1.11.x/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.11.x/installation.html b/docs/en/1.11.x/installation.html index 43b7ee4128..b2c4334468 100644 --- a/docs/en/1.11.x/installation.html +++ b/docs/en/1.11.x/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.11.x/installation/index.html b/docs/en/1.11.x/installation/index.html index 43b7ee4128..b2c4334468 100644 --- a/docs/en/1.11.x/installation/index.html +++ b/docs/en/1.11.x/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.11.x/navigation.html b/docs/en/1.11.x/navigation.html index aa947bd144..dd7c6aa5e1 100644 --- a/docs/en/1.11.x/navigation.html +++ b/docs/en/1.11.x/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.11.x/navigation/index.html b/docs/en/1.11.x/navigation/index.html
index aa947bd144..dd7c6aa5e1 100644
--- a/docs/en/1.11.x/navigation/index.html
+++ b/docs/en/1.11.x/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.11.x/publishing.html b/docs/en/1.11.x/publishing.html
index 358446d151..42b9d06a29 100644
--- a/docs/en/1.11.x/publishing.html
+++ b/docs/en/1.11.x/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.11.x/publishing/index.html b/docs/en/1.11.x/publishing/index.html
index 358446d151..42b9d06a29 100644
--- a/docs/en/1.11.x/publishing/index.html
+++ b/docs/en/1.11.x/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.11.x/search.html b/docs/en/1.11.x/search.html
index 62b33cfe23..abf8c02e7e 100644
--- a/docs/en/1.11.x/search.html
+++ b/docs/en/1.11.x/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.11.x/search/index.html b/docs/en/1.11.x/search/index.html index 62b33cfe23..abf8c02e7e 100644 --- a/docs/en/1.11.x/search/index.html +++ b/docs/en/1.11.x/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.11.x/site-config.html b/docs/en/1.11.x/site-config.html index e53461278f..dbc2b78b3c 100644 --- a/docs/en/1.11.x/site-config.html +++ b/docs/en/1.11.x/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.11.x/site-config/index.html b/docs/en/1.11.x/site-config/index.html index e53461278f..dbc2b78b3c 100644 --- a/docs/en/1.11.x/site-config/index.html +++ b/docs/en/1.11.x/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.11.x/site-creation.html b/docs/en/1.11.x/site-creation.html index 1531a98f50..86c553783e 100644 --- a/docs/en/1.11.x/site-creation.html +++ b/docs/en/1.11.x/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.11.x/site-creation/index.html b/docs/en/1.11.x/site-creation/index.html index 1531a98f50..86c553783e 100644 --- a/docs/en/1.11.x/site-creation/index.html +++ b/docs/en/1.11.x/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.11.x/site-preparation.html b/docs/en/1.11.x/site-preparation.html index 15d26b2c20..0b4fedbe5a 100644 --- a/docs/en/1.11.x/site-preparation.html +++ b/docs/en/1.11.x/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.11.x/site-preparation/index.html b/docs/en/1.11.x/site-preparation/index.html
index 15d26b2c20..0b4fedbe5a 100644
--- a/docs/en/1.11.x/site-preparation/index.html
+++ b/docs/en/1.11.x/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.11.x/translation.html b/docs/en/1.11.x/translation.html
index 8ab3c23ef0..269dbdb8f5 100644
--- a/docs/en/1.11.x/translation.html
+++ b/docs/en/1.11.x/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.11.x/translation/index.html b/docs/en/1.11.x/translation/index.html
index 8ab3c23ef0..269dbdb8f5 100644
--- a/docs/en/1.11.x/translation/index.html
+++ b/docs/en/1.11.x/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.11.x/tutorial-create-new-site.html b/docs/en/1.11.x/tutorial-create-new-site.html
index cfb2381636..0b4a3e8b7b 100644
--- a/docs/en/1.11.x/tutorial-create-new-site.html
+++ b/docs/en/1.11.x/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.11.x/tutorial-create-new-site/index.html b/docs/en/1.11.x/tutorial-create-new-site/index.html index cfb2381636..0b4a3e8b7b 100644 --- a/docs/en/1.11.x/tutorial-create-new-site/index.html +++ b/docs/en/1.11.x/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.11.x/tutorial-create-pages.html b/docs/en/1.11.x/tutorial-create-pages.html index ac943759e4..582f8a4bf2 100644 --- a/docs/en/1.11.x/tutorial-create-pages.html +++ b/docs/en/1.11.x/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.11.x/tutorial-create-pages/index.html b/docs/en/1.11.x/tutorial-create-pages/index.html index ac943759e4..582f8a4bf2 100644 --- a/docs/en/1.11.x/tutorial-create-pages/index.html +++ b/docs/en/1.11.x/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.11.x/tutorial-publish-site.html b/docs/en/1.11.x/tutorial-publish-site.html index d6c064f45b..1f19f46643 100644 --- a/docs/en/1.11.x/tutorial-publish-site.html +++ b/docs/en/1.11.x/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.11.x/tutorial-publish-site/index.html b/docs/en/1.11.x/tutorial-publish-site/index.html index d6c064f45b..1f19f46643 100644 --- a/docs/en/1.11.x/tutorial-publish-site/index.html +++ b/docs/en/1.11.x/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.11.x/tutorial-setup.html b/docs/en/1.11.x/tutorial-setup.html index e55d2ab95f..93238a3785 100644 --- a/docs/en/1.11.x/tutorial-setup.html +++ b/docs/en/1.11.x/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.11.x/tutorial-setup/index.html b/docs/en/1.11.x/tutorial-setup/index.html index e55d2ab95f..93238a3785 100644 --- a/docs/en/1.11.x/tutorial-setup/index.html +++ b/docs/en/1.11.x/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.11.x/tutorial-version.html b/docs/en/1.11.x/tutorial-version.html index 1d064a75db..79991ebb40 100644 --- a/docs/en/1.11.x/tutorial-version.html +++ b/docs/en/1.11.x/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.11.x/tutorial-version/index.html b/docs/en/1.11.x/tutorial-version/index.html index 1d064a75db..79991ebb40 100644 --- a/docs/en/1.11.x/tutorial-version/index.html +++ b/docs/en/1.11.x/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.11.x/versioning.html b/docs/en/1.11.x/versioning.html index b9f0872d83..26676abbfd 100644 --- a/docs/en/1.11.x/versioning.html +++ b/docs/en/1.11.x/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.11.x/versioning/index.html b/docs/en/1.11.x/versioning/index.html
index b9f0872d83..26676abbfd 100644
--- a/docs/en/1.11.x/versioning/index.html
+++ b/docs/en/1.11.x/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.12.0/adding-blog.html b/docs/en/1.12.0/adding-blog.html
index 9101aff014..0c0783b89c 100644
--- a/docs/en/1.12.0/adding-blog.html
+++ b/docs/en/1.12.0/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.12.0/adding-blog/index.html b/docs/en/1.12.0/adding-blog/index.html
index 9101aff014..0c0783b89c 100644
--- a/docs/en/1.12.0/adding-blog/index.html
+++ b/docs/en/1.12.0/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.12.0/api-pages.html b/docs/en/1.12.0/api-pages.html
index a3c946e3d4..24bd0943a6 100644
--- a/docs/en/1.12.0/api-pages.html
+++ b/docs/en/1.12.0/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.12.0/api-pages/index.html b/docs/en/1.12.0/api-pages/index.html index a3c946e3d4..24bd0943a6 100644 --- a/docs/en/1.12.0/api-pages/index.html +++ b/docs/en/1.12.0/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.12.0/commands.html b/docs/en/1.12.0/commands.html index 8e8c61d2bc..bc42c69ab5 100644 --- a/docs/en/1.12.0/commands.html +++ b/docs/en/1.12.0/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.12.0/commands/index.html b/docs/en/1.12.0/commands/index.html index 8e8c61d2bc..bc42c69ab5 100644 --- a/docs/en/1.12.0/commands/index.html +++ b/docs/en/1.12.0/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.12.0/custom-pages.html b/docs/en/1.12.0/custom-pages.html index 7848fc76fb..6e4c0cb833 100644 --- a/docs/en/1.12.0/custom-pages.html +++ b/docs/en/1.12.0/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.12.0/custom-pages/index.html b/docs/en/1.12.0/custom-pages/index.html index 7848fc76fb..6e4c0cb833 100644 --- a/docs/en/1.12.0/custom-pages/index.html +++ b/docs/en/1.12.0/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.12.0/doc-markdown.html b/docs/en/1.12.0/doc-markdown.html index ba3d57a1e3..7bec76c9ab 100644 --- a/docs/en/1.12.0/doc-markdown.html +++ b/docs/en/1.12.0/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.12.0/doc-markdown/index.html b/docs/en/1.12.0/doc-markdown/index.html index ba3d57a1e3..7bec76c9ab 100644 --- a/docs/en/1.12.0/doc-markdown/index.html +++ b/docs/en/1.12.0/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.12.0/docker.html b/docs/en/1.12.0/docker.html index d71840fd63..a9b0ab5cdc 100644 --- a/docs/en/1.12.0/docker.html +++ b/docs/en/1.12.0/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.12.0/docker/index.html b/docs/en/1.12.0/docker/index.html index d71840fd63..a9b0ab5cdc 100644 --- a/docs/en/1.12.0/docker/index.html +++ b/docs/en/1.12.0/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.12.0/installation.html b/docs/en/1.12.0/installation.html index ad4e19b8c0..b4f13a0b4d 100644 --- a/docs/en/1.12.0/installation.html +++ b/docs/en/1.12.0/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.12.0/installation/index.html b/docs/en/1.12.0/installation/index.html index ad4e19b8c0..b4f13a0b4d 100644 --- a/docs/en/1.12.0/installation/index.html +++ b/docs/en/1.12.0/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.12.0/navigation.html b/docs/en/1.12.0/navigation.html index 7865ebc283..96be16b86e 100644 --- a/docs/en/1.12.0/navigation.html +++ b/docs/en/1.12.0/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.12.0/navigation/index.html b/docs/en/1.12.0/navigation/index.html
index 7865ebc283..96be16b86e 100644
--- a/docs/en/1.12.0/navigation/index.html
+++ b/docs/en/1.12.0/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.12.0/publishing.html b/docs/en/1.12.0/publishing.html
index bde76aac71..3480f48466 100644
--- a/docs/en/1.12.0/publishing.html
+++ b/docs/en/1.12.0/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.12.0/publishing/index.html b/docs/en/1.12.0/publishing/index.html
index bde76aac71..3480f48466 100644
--- a/docs/en/1.12.0/publishing/index.html
+++ b/docs/en/1.12.0/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.12.0/search.html b/docs/en/1.12.0/search.html
index 4696339881..5e5a81ca25 100644
--- a/docs/en/1.12.0/search.html
+++ b/docs/en/1.12.0/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.12.0/search/index.html b/docs/en/1.12.0/search/index.html index 4696339881..5e5a81ca25 100644 --- a/docs/en/1.12.0/search/index.html +++ b/docs/en/1.12.0/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.12.0/site-config.html b/docs/en/1.12.0/site-config.html index b2b47166cb..fa29d5c432 100644 --- a/docs/en/1.12.0/site-config.html +++ b/docs/en/1.12.0/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.12.0/site-config/index.html b/docs/en/1.12.0/site-config/index.html index b2b47166cb..fa29d5c432 100644 --- a/docs/en/1.12.0/site-config/index.html +++ b/docs/en/1.12.0/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.12.0/site-creation.html b/docs/en/1.12.0/site-creation.html index 879a32b626..7778d0d1a4 100644 --- a/docs/en/1.12.0/site-creation.html +++ b/docs/en/1.12.0/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.12.0/site-creation/index.html b/docs/en/1.12.0/site-creation/index.html index 879a32b626..7778d0d1a4 100644 --- a/docs/en/1.12.0/site-creation/index.html +++ b/docs/en/1.12.0/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.12.0/site-preparation.html b/docs/en/1.12.0/site-preparation.html index 8105956474..c0412592c7 100644 --- a/docs/en/1.12.0/site-preparation.html +++ b/docs/en/1.12.0/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.12.0/site-preparation/index.html b/docs/en/1.12.0/site-preparation/index.html
index 8105956474..c0412592c7 100644
--- a/docs/en/1.12.0/site-preparation/index.html
+++ b/docs/en/1.12.0/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.12.0/translation.html b/docs/en/1.12.0/translation.html
index c4a33c3135..c623d09e68 100644
--- a/docs/en/1.12.0/translation.html
+++ b/docs/en/1.12.0/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.12.0/translation/index.html b/docs/en/1.12.0/translation/index.html
index c4a33c3135..c623d09e68 100644
--- a/docs/en/1.12.0/translation/index.html
+++ b/docs/en/1.12.0/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.12.0/tutorial-create-new-site.html b/docs/en/1.12.0/tutorial-create-new-site.html
index 353371561d..7db3715ee2 100644
--- a/docs/en/1.12.0/tutorial-create-new-site.html
+++ b/docs/en/1.12.0/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.12.0/tutorial-create-new-site/index.html b/docs/en/1.12.0/tutorial-create-new-site/index.html index 353371561d..7db3715ee2 100644 --- a/docs/en/1.12.0/tutorial-create-new-site/index.html +++ b/docs/en/1.12.0/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.12.0/tutorial-create-pages.html b/docs/en/1.12.0/tutorial-create-pages.html index 6dcecc29c8..168f4e7617 100644 --- a/docs/en/1.12.0/tutorial-create-pages.html +++ b/docs/en/1.12.0/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.12.0/tutorial-create-pages/index.html b/docs/en/1.12.0/tutorial-create-pages/index.html index 6dcecc29c8..168f4e7617 100644 --- a/docs/en/1.12.0/tutorial-create-pages/index.html +++ b/docs/en/1.12.0/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.12.0/tutorial-publish-site.html b/docs/en/1.12.0/tutorial-publish-site.html index ffb7f453a9..5e733855f4 100644 --- a/docs/en/1.12.0/tutorial-publish-site.html +++ b/docs/en/1.12.0/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.12.0/tutorial-publish-site/index.html b/docs/en/1.12.0/tutorial-publish-site/index.html index ffb7f453a9..5e733855f4 100644 --- a/docs/en/1.12.0/tutorial-publish-site/index.html +++ b/docs/en/1.12.0/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.12.0/tutorial-setup.html b/docs/en/1.12.0/tutorial-setup.html index b3bfa17e56..53cac30661 100644 --- a/docs/en/1.12.0/tutorial-setup.html +++ b/docs/en/1.12.0/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.12.0/tutorial-setup/index.html b/docs/en/1.12.0/tutorial-setup/index.html index b3bfa17e56..53cac30661 100644 --- a/docs/en/1.12.0/tutorial-setup/index.html +++ b/docs/en/1.12.0/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.12.0/tutorial-version.html b/docs/en/1.12.0/tutorial-version.html index da4935f70e..87e56f209f 100644 --- a/docs/en/1.12.0/tutorial-version.html +++ b/docs/en/1.12.0/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.12.0/tutorial-version/index.html b/docs/en/1.12.0/tutorial-version/index.html index da4935f70e..87e56f209f 100644 --- a/docs/en/1.12.0/tutorial-version/index.html +++ b/docs/en/1.12.0/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.12.0/versioning.html b/docs/en/1.12.0/versioning.html index a39cd74083..4128c22580 100644 --- a/docs/en/1.12.0/versioning.html +++ b/docs/en/1.12.0/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.12.0/versioning/index.html b/docs/en/1.12.0/versioning/index.html
index a39cd74083..4128c22580 100644
--- a/docs/en/1.12.0/versioning/index.html
+++ b/docs/en/1.12.0/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.13.0/adding-blog.html b/docs/en/1.13.0/adding-blog.html
index 7e6d47f028..2f7e744673 100644
--- a/docs/en/1.13.0/adding-blog.html
+++ b/docs/en/1.13.0/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.13.0/adding-blog/index.html b/docs/en/1.13.0/adding-blog/index.html
index 7e6d47f028..2f7e744673 100644
--- a/docs/en/1.13.0/adding-blog/index.html
+++ b/docs/en/1.13.0/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.13.0/api-pages.html b/docs/en/1.13.0/api-pages.html
index 79a4f4af1f..f8a2809d6a 100644
--- a/docs/en/1.13.0/api-pages.html
+++ b/docs/en/1.13.0/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.13.0/api-pages/index.html b/docs/en/1.13.0/api-pages/index.html index 79a4f4af1f..f8a2809d6a 100644 --- a/docs/en/1.13.0/api-pages/index.html +++ b/docs/en/1.13.0/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.13.0/commands.html b/docs/en/1.13.0/commands.html index 41be1feb14..7c1f349086 100644 --- a/docs/en/1.13.0/commands.html +++ b/docs/en/1.13.0/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.13.0/commands/index.html b/docs/en/1.13.0/commands/index.html index 41be1feb14..7c1f349086 100644 --- a/docs/en/1.13.0/commands/index.html +++ b/docs/en/1.13.0/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.13.0/custom-pages.html b/docs/en/1.13.0/custom-pages.html index 40438e82ce..7a13239c9e 100644 --- a/docs/en/1.13.0/custom-pages.html +++ b/docs/en/1.13.0/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.13.0/custom-pages/index.html b/docs/en/1.13.0/custom-pages/index.html index 40438e82ce..7a13239c9e 100644 --- a/docs/en/1.13.0/custom-pages/index.html +++ b/docs/en/1.13.0/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.13.0/doc-markdown.html b/docs/en/1.13.0/doc-markdown.html index 1d16d6bbd8..3e58459269 100644 --- a/docs/en/1.13.0/doc-markdown.html +++ b/docs/en/1.13.0/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.13.0/doc-markdown/index.html b/docs/en/1.13.0/doc-markdown/index.html index 1d16d6bbd8..3e58459269 100644 --- a/docs/en/1.13.0/doc-markdown/index.html +++ b/docs/en/1.13.0/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.13.0/docker.html b/docs/en/1.13.0/docker.html index d8cc7614e6..19f1e32e32 100644 --- a/docs/en/1.13.0/docker.html +++ b/docs/en/1.13.0/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.13.0/docker/index.html b/docs/en/1.13.0/docker/index.html index d8cc7614e6..19f1e32e32 100644 --- a/docs/en/1.13.0/docker/index.html +++ b/docs/en/1.13.0/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.13.0/installation.html b/docs/en/1.13.0/installation.html index 2ae2201e70..903557fdcd 100644 --- a/docs/en/1.13.0/installation.html +++ b/docs/en/1.13.0/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.13.0/installation/index.html b/docs/en/1.13.0/installation/index.html index 2ae2201e70..903557fdcd 100644 --- a/docs/en/1.13.0/installation/index.html +++ b/docs/en/1.13.0/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.13.0/navigation.html b/docs/en/1.13.0/navigation.html index 0741c0459d..04194d850c 100644 --- a/docs/en/1.13.0/navigation.html +++ b/docs/en/1.13.0/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.13.0/navigation/index.html b/docs/en/1.13.0/navigation/index.html
index 0741c0459d..04194d850c 100644
--- a/docs/en/1.13.0/navigation/index.html
+++ b/docs/en/1.13.0/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.13.0/publishing.html b/docs/en/1.13.0/publishing.html
index ac19922bc6..7753ff14ea 100644
--- a/docs/en/1.13.0/publishing.html
+++ b/docs/en/1.13.0/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.13.0/publishing/index.html b/docs/en/1.13.0/publishing/index.html
index ac19922bc6..7753ff14ea 100644
--- a/docs/en/1.13.0/publishing/index.html
+++ b/docs/en/1.13.0/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.13.0/search.html b/docs/en/1.13.0/search.html
index 2bfab855ae..d5e8579f48 100644
--- a/docs/en/1.13.0/search.html
+++ b/docs/en/1.13.0/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.13.0/search/index.html b/docs/en/1.13.0/search/index.html index 2bfab855ae..d5e8579f48 100644 --- a/docs/en/1.13.0/search/index.html +++ b/docs/en/1.13.0/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.13.0/site-config.html b/docs/en/1.13.0/site-config.html index 4ba967eb80..8269fab62b 100644 --- a/docs/en/1.13.0/site-config.html +++ b/docs/en/1.13.0/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.13.0/site-config/index.html b/docs/en/1.13.0/site-config/index.html index 4ba967eb80..8269fab62b 100644 --- a/docs/en/1.13.0/site-config/index.html +++ b/docs/en/1.13.0/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.13.0/site-creation.html b/docs/en/1.13.0/site-creation.html index c9efbef157..9d97eefee1 100644 --- a/docs/en/1.13.0/site-creation.html +++ b/docs/en/1.13.0/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.13.0/site-creation/index.html b/docs/en/1.13.0/site-creation/index.html index c9efbef157..9d97eefee1 100644 --- a/docs/en/1.13.0/site-creation/index.html +++ b/docs/en/1.13.0/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.13.0/site-preparation.html b/docs/en/1.13.0/site-preparation.html index d0ad1361bd..0b59b1e326 100644 --- a/docs/en/1.13.0/site-preparation.html +++ b/docs/en/1.13.0/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.13.0/site-preparation/index.html b/docs/en/1.13.0/site-preparation/index.html
index d0ad1361bd..0b59b1e326 100644
--- a/docs/en/1.13.0/site-preparation/index.html
+++ b/docs/en/1.13.0/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.13.0/translation.html b/docs/en/1.13.0/translation.html
index 42bdd1f41e..be767502c0 100644
--- a/docs/en/1.13.0/translation.html
+++ b/docs/en/1.13.0/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.13.0/translation/index.html b/docs/en/1.13.0/translation/index.html
index 42bdd1f41e..be767502c0 100644
--- a/docs/en/1.13.0/translation/index.html
+++ b/docs/en/1.13.0/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.13.0/tutorial-create-new-site.html b/docs/en/1.13.0/tutorial-create-new-site.html
index 2d49c54c8b..82390a1ce7 100644
--- a/docs/en/1.13.0/tutorial-create-new-site.html
+++ b/docs/en/1.13.0/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.13.0/tutorial-create-new-site/index.html b/docs/en/1.13.0/tutorial-create-new-site/index.html index 2d49c54c8b..82390a1ce7 100644 --- a/docs/en/1.13.0/tutorial-create-new-site/index.html +++ b/docs/en/1.13.0/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.13.0/tutorial-create-pages.html b/docs/en/1.13.0/tutorial-create-pages.html index cdada61c1e..847b1b3116 100644 --- a/docs/en/1.13.0/tutorial-create-pages.html +++ b/docs/en/1.13.0/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/1.13.0/tutorial-create-pages/index.html b/docs/en/1.13.0/tutorial-create-pages/index.html index cdada61c1e..847b1b3116 100644 --- a/docs/en/1.13.0/tutorial-create-pages/index.html +++ b/docs/en/1.13.0/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/1.13.0/tutorial-publish-site.html b/docs/en/1.13.0/tutorial-publish-site.html index 9b6b9aa7e8..98b5ac795c 100644 --- a/docs/en/1.13.0/tutorial-publish-site.html +++ b/docs/en/1.13.0/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/1.13.0/tutorial-publish-site/index.html b/docs/en/1.13.0/tutorial-publish-site/index.html index 9b6b9aa7e8..98b5ac795c 100644 --- a/docs/en/1.13.0/tutorial-publish-site/index.html +++ b/docs/en/1.13.0/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/1.13.0/tutorial-setup.html b/docs/en/1.13.0/tutorial-setup.html index a14e952406..64ce7f0064 100644 --- a/docs/en/1.13.0/tutorial-setup.html +++ b/docs/en/1.13.0/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/1.13.0/tutorial-setup/index.html b/docs/en/1.13.0/tutorial-setup/index.html index a14e952406..64ce7f0064 100644 --- a/docs/en/1.13.0/tutorial-setup/index.html +++ b/docs/en/1.13.0/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/1.13.0/tutorial-version.html b/docs/en/1.13.0/tutorial-version.html index 553016164b..4d2123922e 100644 --- a/docs/en/1.13.0/tutorial-version.html +++ b/docs/en/1.13.0/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/1.13.0/tutorial-version/index.html b/docs/en/1.13.0/tutorial-version/index.html index 553016164b..4d2123922e 100644 --- a/docs/en/1.13.0/tutorial-version/index.html +++ b/docs/en/1.13.0/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/1.13.0/versioning.html b/docs/en/1.13.0/versioning.html index d4eb763e2c..ac1698bc53 100644 --- a/docs/en/1.13.0/versioning.html +++ b/docs/en/1.13.0/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.13.0/versioning/index.html b/docs/en/1.13.0/versioning/index.html
index d4eb763e2c..ac1698bc53 100644
--- a/docs/en/1.13.0/versioning/index.html
+++ b/docs/en/1.13.0/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.14.4/adding-blog.html b/docs/en/1.14.4/adding-blog.html
index 558d32dac9..7938d90b46 100644
--- a/docs/en/1.14.4/adding-blog.html
+++ b/docs/en/1.14.4/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.14.4/adding-blog/index.html b/docs/en/1.14.4/adding-blog/index.html
index 558d32dac9..7938d90b46 100644
--- a/docs/en/1.14.4/adding-blog/index.html
+++ b/docs/en/1.14.4/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.14.4/api-pages.html b/docs/en/1.14.4/api-pages.html
index 3f6fe441ca..14c3e6ad33 100644
--- a/docs/en/1.14.4/api-pages.html
+++ b/docs/en/1.14.4/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.14.4/api-pages/index.html b/docs/en/1.14.4/api-pages/index.html index 3f6fe441ca..14c3e6ad33 100644 --- a/docs/en/1.14.4/api-pages/index.html +++ b/docs/en/1.14.4/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.14.4/commands.html b/docs/en/1.14.4/commands.html index 9bb2a491e5..268fe8cef9 100644 --- a/docs/en/1.14.4/commands.html +++ b/docs/en/1.14.4/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.14.4/commands/index.html b/docs/en/1.14.4/commands/index.html index 9bb2a491e5..268fe8cef9 100644 --- a/docs/en/1.14.4/commands/index.html +++ b/docs/en/1.14.4/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.14.4/custom-pages.html b/docs/en/1.14.4/custom-pages.html index 8c0d713f08..af36c844ab 100644 --- a/docs/en/1.14.4/custom-pages.html +++ b/docs/en/1.14.4/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.14.4/custom-pages/index.html b/docs/en/1.14.4/custom-pages/index.html index 8c0d713f08..af36c844ab 100644 --- a/docs/en/1.14.4/custom-pages/index.html +++ b/docs/en/1.14.4/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.14.4/doc-markdown.html b/docs/en/1.14.4/doc-markdown.html index 2b5eb92733..4d499451d5 100644 --- a/docs/en/1.14.4/doc-markdown.html +++ b/docs/en/1.14.4/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.14.4/doc-markdown/index.html b/docs/en/1.14.4/doc-markdown/index.html index 2b5eb92733..4d499451d5 100644 --- a/docs/en/1.14.4/doc-markdown/index.html +++ b/docs/en/1.14.4/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.14.4/docker.html b/docs/en/1.14.4/docker.html index 1d1aff54c7..1f5b025a97 100644 --- a/docs/en/1.14.4/docker.html +++ b/docs/en/1.14.4/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.14.4/docker/index.html b/docs/en/1.14.4/docker/index.html index 1d1aff54c7..1f5b025a97 100644 --- a/docs/en/1.14.4/docker/index.html +++ b/docs/en/1.14.4/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.14.4/installation.html b/docs/en/1.14.4/installation.html index f0d73e3f48..b2d672b0e3 100644 --- a/docs/en/1.14.4/installation.html +++ b/docs/en/1.14.4/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/1.14.4/installation/index.html b/docs/en/1.14.4/installation/index.html index f0d73e3f48..b2d672b0e3 100644 --- a/docs/en/1.14.4/installation/index.html +++ b/docs/en/1.14.4/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/1.14.4/navigation.html b/docs/en/1.14.4/navigation.html index 07230024e3..865b82f2f0 100644 --- a/docs/en/1.14.4/navigation.html +++ b/docs/en/1.14.4/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.14.4/navigation/index.html b/docs/en/1.14.4/navigation/index.html
index 07230024e3..865b82f2f0 100644
--- a/docs/en/1.14.4/navigation/index.html
+++ b/docs/en/1.14.4/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.14.4/publishing.html b/docs/en/1.14.4/publishing.html
index e0330754f3..9727929f27 100644
--- a/docs/en/1.14.4/publishing.html
+++ b/docs/en/1.14.4/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.14.4/publishing/index.html b/docs/en/1.14.4/publishing/index.html
index e0330754f3..9727929f27 100644
--- a/docs/en/1.14.4/publishing/index.html
+++ b/docs/en/1.14.4/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.14.4/search.html b/docs/en/1.14.4/search.html
index cf58c636d3..3a7af96310 100644
--- a/docs/en/1.14.4/search.html
+++ b/docs/en/1.14.4/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.14.4/search/index.html b/docs/en/1.14.4/search/index.html index cf58c636d3..3a7af96310 100644 --- a/docs/en/1.14.4/search/index.html +++ b/docs/en/1.14.4/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.14.4/site-config.html b/docs/en/1.14.4/site-config.html index bf1b2e94f7..70cf46f6be 100644 --- a/docs/en/1.14.4/site-config.html +++ b/docs/en/1.14.4/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.14.4/site-config/index.html b/docs/en/1.14.4/site-config/index.html index bf1b2e94f7..70cf46f6be 100644 --- a/docs/en/1.14.4/site-config/index.html +++ b/docs/en/1.14.4/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.14.4/site-creation.html b/docs/en/1.14.4/site-creation.html index aa379f4dfa..12b94b580a 100644 --- a/docs/en/1.14.4/site-creation.html +++ b/docs/en/1.14.4/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.14.4/site-creation/index.html b/docs/en/1.14.4/site-creation/index.html index aa379f4dfa..12b94b580a 100644 --- a/docs/en/1.14.4/site-creation/index.html +++ b/docs/en/1.14.4/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.14.4/site-preparation.html b/docs/en/1.14.4/site-preparation.html index c0709224ad..aad9b7ba2b 100644 --- a/docs/en/1.14.4/site-preparation.html +++ b/docs/en/1.14.4/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.14.4/site-preparation/index.html b/docs/en/1.14.4/site-preparation/index.html
index c0709224ad..aad9b7ba2b 100644
--- a/docs/en/1.14.4/site-preparation/index.html
+++ b/docs/en/1.14.4/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.14.4/translation.html b/docs/en/1.14.4/translation.html
index 090396a4c4..ee4efbf2b0 100644
--- a/docs/en/1.14.4/translation.html
+++ b/docs/en/1.14.4/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.14.4/translation/index.html b/docs/en/1.14.4/translation/index.html
index 090396a4c4..ee4efbf2b0 100644
--- a/docs/en/1.14.4/translation/index.html
+++ b/docs/en/1.14.4/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.14.4/tutorial-create-new-site.html b/docs/en/1.14.4/tutorial-create-new-site.html
index 68b3a5f9e2..ec0453f272 100644
--- a/docs/en/1.14.4/tutorial-create-new-site.html
+++ b/docs/en/1.14.4/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.14.4/tutorial-create-new-site/index.html b/docs/en/1.14.4/tutorial-create-new-site/index.html index 68b3a5f9e2..ec0453f272 100644 --- a/docs/en/1.14.4/tutorial-create-new-site/index.html +++ b/docs/en/1.14.4/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.14.4/tutorial-create-pages.html b/docs/en/1.14.4/tutorial-create-pages.html index 1f20030b77..36bceedc8c 100644 --- a/docs/en/1.14.4/tutorial-create-pages.html +++ b/docs/en/1.14.4/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/1.14.4/tutorial-create-pages/index.html b/docs/en/1.14.4/tutorial-create-pages/index.html index 1f20030b77..36bceedc8c 100644 --- a/docs/en/1.14.4/tutorial-create-pages/index.html +++ b/docs/en/1.14.4/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/1.14.4/tutorial-publish-site.html b/docs/en/1.14.4/tutorial-publish-site.html index d38c0bca9a..fff04b51db 100644 --- a/docs/en/1.14.4/tutorial-publish-site.html +++ b/docs/en/1.14.4/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/1.14.4/tutorial-publish-site/index.html b/docs/en/1.14.4/tutorial-publish-site/index.html index d38c0bca9a..fff04b51db 100644 --- a/docs/en/1.14.4/tutorial-publish-site/index.html +++ b/docs/en/1.14.4/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/1.14.4/tutorial-setup.html b/docs/en/1.14.4/tutorial-setup.html index 8273c04f36..1bafb3bd99 100644 --- a/docs/en/1.14.4/tutorial-setup.html +++ b/docs/en/1.14.4/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/1.14.4/tutorial-setup/index.html b/docs/en/1.14.4/tutorial-setup/index.html index 8273c04f36..1bafb3bd99 100644 --- a/docs/en/1.14.4/tutorial-setup/index.html +++ b/docs/en/1.14.4/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/1.14.4/tutorial-version.html b/docs/en/1.14.4/tutorial-version.html index 99afe4948e..3c6eb78250 100644 --- a/docs/en/1.14.4/tutorial-version.html +++ b/docs/en/1.14.4/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/1.14.4/tutorial-version/index.html b/docs/en/1.14.4/tutorial-version/index.html index 99afe4948e..3c6eb78250 100644 --- a/docs/en/1.14.4/tutorial-version/index.html +++ b/docs/en/1.14.4/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/1.14.4/versioning.html b/docs/en/1.14.4/versioning.html index bf91e28d10..b4f6109331 100644 --- a/docs/en/1.14.4/versioning.html +++ b/docs/en/1.14.4/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.14.4/versioning/index.html b/docs/en/1.14.4/versioning/index.html
index bf91e28d10..b4f6109331 100644
--- a/docs/en/1.14.4/versioning/index.html
+++ b/docs/en/1.14.4/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.14.5/adding-blog.html b/docs/en/1.14.5/adding-blog.html
index 84afbcca7f..8d7483aa27 100644
--- a/docs/en/1.14.5/adding-blog.html
+++ b/docs/en/1.14.5/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.14.5/adding-blog/index.html b/docs/en/1.14.5/adding-blog/index.html
index 84afbcca7f..8d7483aa27 100644
--- a/docs/en/1.14.5/adding-blog/index.html
+++ b/docs/en/1.14.5/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.14.5/api-pages.html b/docs/en/1.14.5/api-pages.html
index 5368e62b9b..7976e6c5ff 100644
--- a/docs/en/1.14.5/api-pages.html
+++ b/docs/en/1.14.5/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.14.5/api-pages/index.html b/docs/en/1.14.5/api-pages/index.html index 5368e62b9b..7976e6c5ff 100644 --- a/docs/en/1.14.5/api-pages/index.html +++ b/docs/en/1.14.5/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.14.5/commands.html b/docs/en/1.14.5/commands.html index 36cf29cc08..3a64a84733 100644 --- a/docs/en/1.14.5/commands.html +++ b/docs/en/1.14.5/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.14.5/commands/index.html b/docs/en/1.14.5/commands/index.html index 36cf29cc08..3a64a84733 100644 --- a/docs/en/1.14.5/commands/index.html +++ b/docs/en/1.14.5/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.14.5/custom-pages.html b/docs/en/1.14.5/custom-pages.html index 2ec5e7e47b..2c7599c50a 100644 --- a/docs/en/1.14.5/custom-pages.html +++ b/docs/en/1.14.5/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.14.5/custom-pages/index.html b/docs/en/1.14.5/custom-pages/index.html index 2ec5e7e47b..2c7599c50a 100644 --- a/docs/en/1.14.5/custom-pages/index.html +++ b/docs/en/1.14.5/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.14.5/doc-markdown.html b/docs/en/1.14.5/doc-markdown.html index 84c7251c1e..79347617cc 100644 --- a/docs/en/1.14.5/doc-markdown.html +++ b/docs/en/1.14.5/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.14.5/doc-markdown/index.html b/docs/en/1.14.5/doc-markdown/index.html index 84c7251c1e..79347617cc 100644 --- a/docs/en/1.14.5/doc-markdown/index.html +++ b/docs/en/1.14.5/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.14.5/docker.html b/docs/en/1.14.5/docker.html index 74a59526d9..f9753217fc 100644 --- a/docs/en/1.14.5/docker.html +++ b/docs/en/1.14.5/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.14.5/docker/index.html b/docs/en/1.14.5/docker/index.html index 74a59526d9..f9753217fc 100644 --- a/docs/en/1.14.5/docker/index.html +++ b/docs/en/1.14.5/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.14.5/installation.html b/docs/en/1.14.5/installation.html index b61f1cd947..a182503dff 100644 --- a/docs/en/1.14.5/installation.html +++ b/docs/en/1.14.5/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/1.14.5/installation/index.html b/docs/en/1.14.5/installation/index.html index b61f1cd947..a182503dff 100644 --- a/docs/en/1.14.5/installation/index.html +++ b/docs/en/1.14.5/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/1.14.5/navigation.html b/docs/en/1.14.5/navigation.html index d155f4871f..a406eaadcc 100644 --- a/docs/en/1.14.5/navigation.html +++ b/docs/en/1.14.5/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.14.5/navigation/index.html b/docs/en/1.14.5/navigation/index.html
index d155f4871f..a406eaadcc 100644
--- a/docs/en/1.14.5/navigation/index.html
+++ b/docs/en/1.14.5/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.14.5/publishing.html b/docs/en/1.14.5/publishing.html
index f37ff5efcc..eb9659c8ba 100644
--- a/docs/en/1.14.5/publishing.html
+++ b/docs/en/1.14.5/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.14.5/publishing/index.html b/docs/en/1.14.5/publishing/index.html
index f37ff5efcc..eb9659c8ba 100644
--- a/docs/en/1.14.5/publishing/index.html
+++ b/docs/en/1.14.5/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.14.5/search.html b/docs/en/1.14.5/search.html
index 5953426c31..184c57b6a6 100644
--- a/docs/en/1.14.5/search.html
+++ b/docs/en/1.14.5/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.14.5/search/index.html b/docs/en/1.14.5/search/index.html index 5953426c31..184c57b6a6 100644 --- a/docs/en/1.14.5/search/index.html +++ b/docs/en/1.14.5/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.14.5/site-config.html b/docs/en/1.14.5/site-config.html index 03b26c768f..ef1ea982fc 100644 --- a/docs/en/1.14.5/site-config.html +++ b/docs/en/1.14.5/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.14.5/site-config/index.html b/docs/en/1.14.5/site-config/index.html index 03b26c768f..ef1ea982fc 100644 --- a/docs/en/1.14.5/site-config/index.html +++ b/docs/en/1.14.5/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.14.5/site-creation.html b/docs/en/1.14.5/site-creation.html index 16e47ab790..bc856ac561 100644 --- a/docs/en/1.14.5/site-creation.html +++ b/docs/en/1.14.5/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.14.5/site-creation/index.html b/docs/en/1.14.5/site-creation/index.html index 16e47ab790..bc856ac561 100644 --- a/docs/en/1.14.5/site-creation/index.html +++ b/docs/en/1.14.5/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.14.5/site-preparation.html b/docs/en/1.14.5/site-preparation.html index a366032011..45f5718173 100644 --- a/docs/en/1.14.5/site-preparation.html +++ b/docs/en/1.14.5/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.14.5/site-preparation/index.html b/docs/en/1.14.5/site-preparation/index.html
index a366032011..45f5718173 100644
--- a/docs/en/1.14.5/site-preparation/index.html
+++ b/docs/en/1.14.5/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.14.5/translation.html b/docs/en/1.14.5/translation.html
index 9094e6cd48..8947590180 100644
--- a/docs/en/1.14.5/translation.html
+++ b/docs/en/1.14.5/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.14.5/translation/index.html b/docs/en/1.14.5/translation/index.html
index 9094e6cd48..8947590180 100644
--- a/docs/en/1.14.5/translation/index.html
+++ b/docs/en/1.14.5/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.14.5/tutorial-create-new-site.html b/docs/en/1.14.5/tutorial-create-new-site.html
index d6ba30bdbe..96c0222f69 100644
--- a/docs/en/1.14.5/tutorial-create-new-site.html
+++ b/docs/en/1.14.5/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.14.5/tutorial-create-new-site/index.html b/docs/en/1.14.5/tutorial-create-new-site/index.html index d6ba30bdbe..96c0222f69 100644 --- a/docs/en/1.14.5/tutorial-create-new-site/index.html +++ b/docs/en/1.14.5/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.14.5/tutorial-create-pages.html b/docs/en/1.14.5/tutorial-create-pages.html index efda5477b8..2c18dc307b 100644 --- a/docs/en/1.14.5/tutorial-create-pages.html +++ b/docs/en/1.14.5/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/1.14.5/tutorial-create-pages/index.html b/docs/en/1.14.5/tutorial-create-pages/index.html index efda5477b8..2c18dc307b 100644 --- a/docs/en/1.14.5/tutorial-create-pages/index.html +++ b/docs/en/1.14.5/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/1.14.5/tutorial-publish-site.html b/docs/en/1.14.5/tutorial-publish-site.html index 3078de2659..579ce79a37 100644 --- a/docs/en/1.14.5/tutorial-publish-site.html +++ b/docs/en/1.14.5/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/1.14.5/tutorial-publish-site/index.html b/docs/en/1.14.5/tutorial-publish-site/index.html index 3078de2659..579ce79a37 100644 --- a/docs/en/1.14.5/tutorial-publish-site/index.html +++ b/docs/en/1.14.5/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/1.14.5/tutorial-setup.html b/docs/en/1.14.5/tutorial-setup.html index ba8e512ada..6b1bc68b88 100644 --- a/docs/en/1.14.5/tutorial-setup.html +++ b/docs/en/1.14.5/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/1.14.5/tutorial-setup/index.html b/docs/en/1.14.5/tutorial-setup/index.html index ba8e512ada..6b1bc68b88 100644 --- a/docs/en/1.14.5/tutorial-setup/index.html +++ b/docs/en/1.14.5/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/1.14.5/tutorial-version.html b/docs/en/1.14.5/tutorial-version.html index 9a4ab0df7f..30169ee61e 100644 --- a/docs/en/1.14.5/tutorial-version.html +++ b/docs/en/1.14.5/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/1.14.5/tutorial-version/index.html b/docs/en/1.14.5/tutorial-version/index.html index 9a4ab0df7f..30169ee61e 100644 --- a/docs/en/1.14.5/tutorial-version/index.html +++ b/docs/en/1.14.5/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/1.14.5/versioning.html b/docs/en/1.14.5/versioning.html index a9a5f0b176..ad323c06db 100644 --- a/docs/en/1.14.5/versioning.html +++ b/docs/en/1.14.5/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.14.5/versioning/index.html b/docs/en/1.14.5/versioning/index.html
index a9a5f0b176..ad323c06db 100644
--- a/docs/en/1.14.5/versioning/index.html
+++ b/docs/en/1.14.5/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.9.x/adding-blog.html b/docs/en/1.9.x/adding-blog.html
index dc916b9b45..0098f79334 100644
--- a/docs/en/1.9.x/adding-blog.html
+++ b/docs/en/1.9.x/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.9.x/adding-blog/index.html b/docs/en/1.9.x/adding-blog/index.html
index dc916b9b45..0098f79334 100644
--- a/docs/en/1.9.x/adding-blog/index.html
+++ b/docs/en/1.9.x/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/1.9.x/api-pages.html b/docs/en/1.9.x/api-pages.html
index bc7c2a6fef..9289b989fb 100644
--- a/docs/en/1.9.x/api-pages.html
+++ b/docs/en/1.9.x/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.9.x/api-pages/index.html b/docs/en/1.9.x/api-pages/index.html index bc7c2a6fef..9289b989fb 100644 --- a/docs/en/1.9.x/api-pages/index.html +++ b/docs/en/1.9.x/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/1.9.x/commands.html b/docs/en/1.9.x/commands.html index 796048082e..113a5fdf94 100644 --- a/docs/en/1.9.x/commands.html +++ b/docs/en/1.9.x/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.9.x/commands/index.html b/docs/en/1.9.x/commands/index.html index 796048082e..113a5fdf94 100644 --- a/docs/en/1.9.x/commands/index.html +++ b/docs/en/1.9.x/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/1.9.x/custom-pages.html b/docs/en/1.9.x/custom-pages.html index 1071be6028..38d5b13baa 100644 --- a/docs/en/1.9.x/custom-pages.html +++ b/docs/en/1.9.x/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.9.x/custom-pages/index.html b/docs/en/1.9.x/custom-pages/index.html index 1071be6028..38d5b13baa 100644 --- a/docs/en/1.9.x/custom-pages/index.html +++ b/docs/en/1.9.x/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/1.9.x/doc-markdown.html b/docs/en/1.9.x/doc-markdown.html index 50662ded40..14353cb2ad 100644 --- a/docs/en/1.9.x/doc-markdown.html +++ b/docs/en/1.9.x/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.9.x/doc-markdown/index.html b/docs/en/1.9.x/doc-markdown/index.html index 50662ded40..14353cb2ad 100644 --- a/docs/en/1.9.x/doc-markdown/index.html +++ b/docs/en/1.9.x/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/1.9.x/docker.html b/docs/en/1.9.x/docker.html index 0387e2e53a..45e84a90d2 100644 --- a/docs/en/1.9.x/docker.html +++ b/docs/en/1.9.x/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.9.x/docker/index.html b/docs/en/1.9.x/docker/index.html index 0387e2e53a..45e84a90d2 100644 --- a/docs/en/1.9.x/docker/index.html +++ b/docs/en/1.9.x/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/1.9.x/installation.html b/docs/en/1.9.x/installation.html index 8309484931..02b45a7dee 100644 --- a/docs/en/1.9.x/installation.html +++ b/docs/en/1.9.x/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.9.x/installation/index.html b/docs/en/1.9.x/installation/index.html index 8309484931..02b45a7dee 100644 --- a/docs/en/1.9.x/installation/index.html +++ b/docs/en/1.9.x/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Installing Docusaurus

We have created an easy script that will get all of the infrastructure set up for you:

    diff --git a/docs/en/1.9.x/navigation.html b/docs/en/1.9.x/navigation.html index 2abb8e8daf..5f8747da4e 100644 --- a/docs/en/1.9.x/navigation.html +++ b/docs/en/1.9.x/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.9.x/navigation/index.html b/docs/en/1.9.x/navigation/index.html
index 2abb8e8daf..5f8747da4e 100644
--- a/docs/en/1.9.x/navigation/index.html
+++ b/docs/en/1.9.x/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/1.9.x/publishing.html b/docs/en/1.9.x/publishing.html
index 493f6e8d76..cb8d66016e 100644
--- a/docs/en/1.9.x/publishing.html
+++ b/docs/en/1.9.x/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.9.x/publishing/index.html b/docs/en/1.9.x/publishing/index.html
index 493f6e8d76..cb8d66016e 100644
--- a/docs/en/1.9.x/publishing/index.html
+++ b/docs/en/1.9.x/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/1.9.x/search.html b/docs/en/1.9.x/search.html
index 0729a01c02..5bb3b844f5 100644
--- a/docs/en/1.9.x/search.html
+++ b/docs/en/1.9.x/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.9.x/search/index.html b/docs/en/1.9.x/search/index.html index 0729a01c02..5bb3b844f5 100644 --- a/docs/en/1.9.x/search/index.html +++ b/docs/en/1.9.x/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/1.9.x/site-config.html b/docs/en/1.9.x/site-config.html index 2f4aa648eb..dafe21d700 100644 --- a/docs/en/1.9.x/site-config.html +++ b/docs/en/1.9.x/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.9.x/site-config/index.html b/docs/en/1.9.x/site-config/index.html index 2f4aa648eb..dafe21d700 100644 --- a/docs/en/1.9.x/site-config/index.html +++ b/docs/en/1.9.x/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/1.9.x/site-creation.html b/docs/en/1.9.x/site-creation.html index fbef8e4073..d64cf44e25 100644 --- a/docs/en/1.9.x/site-creation.html +++ b/docs/en/1.9.x/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.9.x/site-creation/index.html b/docs/en/1.9.x/site-creation/index.html index fbef8e4073..d64cf44e25 100644 --- a/docs/en/1.9.x/site-creation/index.html +++ b/docs/en/1.9.x/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/1.9.x/site-preparation.html b/docs/en/1.9.x/site-preparation.html index d2420141b9..8ac463a37b 100644 --- a/docs/en/1.9.x/site-preparation.html +++ b/docs/en/1.9.x/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.9.x/site-preparation/index.html b/docs/en/1.9.x/site-preparation/index.html
index d2420141b9..8ac463a37b 100644
--- a/docs/en/1.9.x/site-preparation/index.html
+++ b/docs/en/1.9.x/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/1.9.x/translation.html b/docs/en/1.9.x/translation.html
index 4bc852df4d..b0ba235369 100644
--- a/docs/en/1.9.x/translation.html
+++ b/docs/en/1.9.x/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.9.x/translation/index.html b/docs/en/1.9.x/translation/index.html
index 4bc852df4d..b0ba235369 100644
--- a/docs/en/1.9.x/translation/index.html
+++ b/docs/en/1.9.x/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/1.9.x/tutorial-create-new-site.html b/docs/en/1.9.x/tutorial-create-new-site.html
index 29b2ac9763..2e9c5ec763 100644
--- a/docs/en/1.9.x/tutorial-create-new-site.html
+++ b/docs/en/1.9.x/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.9.x/tutorial-create-new-site/index.html b/docs/en/1.9.x/tutorial-create-new-site/index.html index 29b2ac9763..2e9c5ec763 100644 --- a/docs/en/1.9.x/tutorial-create-new-site/index.html +++ b/docs/en/1.9.x/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/1.9.x/tutorial-create-pages.html b/docs/en/1.9.x/tutorial-create-pages.html index 384d011f4f..f7c78442c8 100644 --- a/docs/en/1.9.x/tutorial-create-pages.html +++ b/docs/en/1.9.x/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.9.x/tutorial-create-pages/index.html b/docs/en/1.9.x/tutorial-create-pages/index.html index 384d011f4f..f7c78442c8 100644 --- a/docs/en/1.9.x/tutorial-create-pages/index.html +++ b/docs/en/1.9.x/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Creating a Regular Page

    diff --git a/docs/en/1.9.x/tutorial-publish-site.html b/docs/en/1.9.x/tutorial-publish-site.html index 77f61f37ed..3f3bfd3c99 100644 --- a/docs/en/1.9.x/tutorial-publish-site.html +++ b/docs/en/1.9.x/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.9.x/tutorial-publish-site/index.html b/docs/en/1.9.x/tutorial-publish-site/index.html index 77f61f37ed..3f3bfd3c99 100644 --- a/docs/en/1.9.x/tutorial-publish-site/index.html +++ b/docs/en/1.9.x/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub pages to host our website. But you can use any static file hosting service that you want, e.g. Netlify, Amazon S3, etc.

Put the Site Online

Kill the web server first by pressing Cmd + C or Ctrl + C depending on your operating system.

diff --git a/docs/en/1.9.x/tutorial-setup.html b/docs/en/1.9.x/tutorial-setup.html index 64792eb08c..3c7b09674f 100644 --- a/docs/en/1.9.x/tutorial-setup.html +++ b/docs/en/1.9.x/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.9.x/tutorial-setup/index.html b/docs/en/1.9.x/tutorial-setup/index.html index 64792eb08c..3c7b09674f 100644 --- a/docs/en/1.9.x/tutorial-setup/index.html +++ b/docs/en/1.9.x/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Node.js

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps.

diff --git a/docs/en/1.9.x/tutorial-version.html b/docs/en/1.9.x/tutorial-version.html index 941ea7821a..bbdcaf7deb 100644 --- a/docs/en/1.9.x/tutorial-version.html +++ b/docs/en/1.9.x/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.9.x/tutorial-version/index.html b/docs/en/1.9.x/tutorial-version/index.html index 941ea7821a..bbdcaf7deb 100644 --- a/docs/en/1.9.x/tutorial-version/index.html +++ b/docs/en/1.9.x/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus - versioned documentation. Versioned documentation helps to show relevant documentation to the users for the current version of the tool they are using and also hide unreleased documentation from users, reducing confusion. Documentations for older versions are also preserved and accessible to users of older versions of the tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assuming we are happy with the current state of the documentation and we want to freeze it as the v1.0.0 docs. We first run the following command to generate a versions.js file, which will be used to list down all the versions of docs in the project.

diff --git a/docs/en/1.9.x/versioning.html b/docs/en/1.9.x/versioning.html index e0c1015226..adb3113847 100644 --- a/docs/en/1.9.x/versioning.html +++ b/docs/en/1.9.x/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/1.9.x/versioning/index.html b/docs/en/1.9.x/versioning/index.html
index e0c1015226..adb3113847 100644
--- a/docs/en/1.9.x/versioning/index.html
+++ b/docs/en/1.9.x/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/adding-blog.html b/docs/en/adding-blog.html
index 97b1202c18..3f20420a00 100644
--- a/docs/en/adding-blog.html
+++ b/docs/en/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/adding-blog/index.html b/docs/en/adding-blog/index.html
index 97b1202c18..3f20420a00 100644
--- a/docs/en/adding-blog/index.html
+++ b/docs/en/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/api-pages.html b/docs/en/api-pages.html
index 5e12b8bbc1..30923f99a0 100644
--- a/docs/en/api-pages.html
+++ b/docs/en/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/api-pages/index.html b/docs/en/api-pages/index.html index 5e12b8bbc1..30923f99a0 100644 --- a/docs/en/api-pages/index.html +++ b/docs/en/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/commands.html b/docs/en/commands.html index 6922df5e97..1bb031352b 100644 --- a/docs/en/commands.html +++ b/docs/en/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/commands/index.html b/docs/en/commands/index.html index 6922df5e97..1bb031352b 100644 --- a/docs/en/commands/index.html +++ b/docs/en/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/custom-pages.html b/docs/en/custom-pages.html index e4608a1367..61d06df1e0 100644 --- a/docs/en/custom-pages.html +++ b/docs/en/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/custom-pages/index.html b/docs/en/custom-pages/index.html index e4608a1367..61d06df1e0 100644 --- a/docs/en/custom-pages/index.html +++ b/docs/en/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/doc-markdown.html b/docs/en/doc-markdown.html index 9a4cdafeda..845a4c301e 100644 --- a/docs/en/doc-markdown.html +++ b/docs/en/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/doc-markdown/index.html b/docs/en/doc-markdown/index.html index 9a4cdafeda..845a4c301e 100644 --- a/docs/en/doc-markdown/index.html +++ b/docs/en/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/docker.html b/docs/en/docker.html index 1270e07d6d..5510496b03 100644 --- a/docs/en/docker.html +++ b/docs/en/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/docker/index.html b/docs/en/docker/index.html index 1270e07d6d..5510496b03 100644 --- a/docs/en/docker/index.html +++ b/docs/en/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/installation.html b/docs/en/installation.html index 5a1b002d11..5da64a99dc 100644 --- a/docs/en/installation.html +++ b/docs/en/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/installation/index.html b/docs/en/installation/index.html index 5a1b002d11..5da64a99dc 100644 --- a/docs/en/installation/index.html +++ b/docs/en/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/navigation.html b/docs/en/navigation.html index 4e5f94fcc4..f072a8280c 100644 --- a/docs/en/navigation.html +++ b/docs/en/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/navigation/index.html b/docs/en/navigation/index.html
index 4e5f94fcc4..f072a8280c 100644
--- a/docs/en/navigation/index.html
+++ b/docs/en/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/next/adding-blog.html b/docs/en/next/adding-blog.html
index f72f190dc6..5403bb6d28 100644
--- a/docs/en/next/adding-blog.html
+++ b/docs/en/next/adding-blog.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/next/adding-blog/index.html b/docs/en/next/adding-blog/index.html
index f72f190dc6..5403bb6d28 100644
--- a/docs/en/next/adding-blog/index.html
+++ b/docs/en/next/adding-blog/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Adding a Blog

Initial Setup

+
Edit

Adding a Blog

Initial Setup

To setup your site's blog, start by creating a blog directory within your repo's website directory.

Then, add a header link to your blog within siteConfig.js:

headerLinks: [
diff --git a/docs/en/next/api-pages.html b/docs/en/next/api-pages.html
index 0be318ae37..d8cd85d64b 100644
--- a/docs/en/next/api-pages.html
+++ b/docs/en/next/api-pages.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/next/api-pages/index.html b/docs/en/next/api-pages/index.html index 0be318ae37..d8cd85d64b 100644 --- a/docs/en/next/api-pages/index.html +++ b/docs/en/next/api-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+
Edit

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

Provided Props

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

Example

diff --git a/docs/en/next/commands.html b/docs/en/next/commands.html index accaa4af37..ab439c02c6 100644 --- a/docs/en/next/commands.html +++ b/docs/en/next/commands.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/next/commands/index.html b/docs/en/next/commands/index.html index accaa4af37..ab439c02c6 100644 --- a/docs/en/next/commands/index.html +++ b/docs/en/next/commands/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

+
Edit

CLI Commands

Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the run command when using Yarn or npm. Some common commands are:

  • yarn run start: build and serve the website from a local server
  • yarn run examples: create example configuration files
    • diff --git a/docs/en/next/custom-pages.html b/docs/en/next/custom-pages.html index 7de846603a..0b8d1420a2 100644 --- a/docs/en/next/custom-pages.html +++ b/docs/en/next/custom-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/next/custom-pages/index.html b/docs/en/next/custom-pages/index.html index 7de846603a..0b8d1420a2 100644 --- a/docs/en/next/custom-pages/index.html +++ b/docs/en/next/custom-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+
Edit

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

Customizing Your Home Page

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. From there, edit the website/pages/en/index.js file and its various components to use the images and text you want for your project.

diff --git a/docs/en/next/doc-markdown.html b/docs/en/next/doc-markdown.html index cf303513d5..404b31eee4 100644 --- a/docs/en/next/doc-markdown.html +++ b/docs/en/next/doc-markdown.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/next/doc-markdown/index.html b/docs/en/next/doc-markdown/index.html index cf303513d5..404b31eee4 100644 --- a/docs/en/next/doc-markdown/index.html +++ b/docs/en/next/doc-markdown/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+
Edit

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

Markdown Headers

Documents

Documents use the following markdown header fields that are enclosed by a line --- on either side:

diff --git a/docs/en/next/docker.html b/docs/en/next/docker.html index ae80e31d8b..9104833a67 100644 --- a/docs/en/next/docker.html +++ b/docs/en/next/docker.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/next/docker/index.html b/docs/en/next/docker/index.html index ae80e31d8b..9104833a67 100644 --- a/docs/en/next/docker/index.html +++ b/docs/en/next/docker/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+
Edit

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

Run the local web server in docker

Ensure you have previously installed docker.

To run the local web server:

diff --git a/docs/en/next/installation.html b/docs/en/next/installation.html index e85c5c8bfc..bdd64a3269 100644 --- a/docs/en/next/installation.html +++ b/docs/en/next/installation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/next/installation/index.html b/docs/en/next/installation/index.html index e85c5c8bfc..bdd64a3269 100644 --- a/docs/en/next/installation/index.html +++ b/docs/en/next/installation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+
Edit

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

diff --git a/docs/en/next/navigation.html b/docs/en/next/navigation.html index 434123f202..4737f2e373 100644 --- a/docs/en/next/navigation.html +++ b/docs/en/next/navigation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/next/navigation/index.html b/docs/en/next/navigation/index.html
index 434123f202..4737f2e373 100644
--- a/docs/en/next/navigation/index.html
+++ b/docs/en/next/navigation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Navigation and Sidebars

Referencing Site Documents

+
Edit

Navigation and Sidebars

Referencing Site Documents

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in doc2.md and you want to reference doc1.md:

I am referencing a [document](doc1.md).
diff --git a/docs/en/next/publishing.html b/docs/en/next/publishing.html
index 62e1c630a6..c4ed1a8078 100644
--- a/docs/en/next/publishing.html
+++ b/docs/en/next/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/next/publishing/index.html b/docs/en/next/publishing/index.html
index 62e1c630a6..c4ed1a8078 100644
--- a/docs/en/next/publishing/index.html
+++ b/docs/en/next/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/next/search.html b/docs/en/next/search.html
index f9d8cfad87..dc3e0b9720 100644
--- a/docs/en/next/search.html
+++ b/docs/en/next/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/next/search/index.html b/docs/en/next/search/index.html index f9d8cfad87..dc3e0b9720 100644 --- a/docs/en/next/search/index.html +++ b/docs/en/next/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/next/site-config.html b/docs/en/next/site-config.html index e7fd0ca4f9..8009b0bc24 100644 --- a/docs/en/next/site-config.html +++ b/docs/en/next/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/next/site-config/index.html b/docs/en/next/site-config/index.html index e7fd0ca4f9..8009b0bc24 100644 --- a/docs/en/next/site-config/index.html +++ b/docs/en/next/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/next/site-creation.html b/docs/en/next/site-creation.html index 1385ac1b5b..6091cbbc08 100644 --- a/docs/en/next/site-creation.html +++ b/docs/en/next/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/next/site-creation/index.html b/docs/en/next/site-creation/index.html index 1385ac1b5b..6091cbbc08 100644 --- a/docs/en/next/site-creation/index.html +++ b/docs/en/next/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/next/site-preparation.html b/docs/en/next/site-preparation.html index 21fa594ae4..32186f1980 100644 --- a/docs/en/next/site-preparation.html +++ b/docs/en/next/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/next/site-preparation/index.html b/docs/en/next/site-preparation/index.html
index 21fa594ae4..32186f1980 100644
--- a/docs/en/next/site-preparation/index.html
+++ b/docs/en/next/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/next/translation.html b/docs/en/next/translation.html
index 652dccacf4..5b0694cc4a 100644
--- a/docs/en/next/translation.html
+++ b/docs/en/next/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/next/translation/index.html b/docs/en/next/translation/index.html
index 652dccacf4..5b0694cc4a 100644
--- a/docs/en/next/translation/index.html
+++ b/docs/en/next/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/next/tutorial-create-new-site.html b/docs/en/next/tutorial-create-new-site.html
index 7c8c2f5f96..fbdbe16465 100644
--- a/docs/en/next/tutorial-create-new-site.html
+++ b/docs/en/next/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/next/tutorial-create-new-site/index.html b/docs/en/next/tutorial-create-new-site/index.html index 7c8c2f5f96..fbdbe16465 100644 --- a/docs/en/next/tutorial-create-new-site/index.html +++ b/docs/en/next/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/next/tutorial-create-pages.html b/docs/en/next/tutorial-create-pages.html index 6ce8657039..99a20f7c12 100644 --- a/docs/en/next/tutorial-create-pages.html +++ b/docs/en/next/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/next/tutorial-create-pages/index.html b/docs/en/next/tutorial-create-pages/index.html index 6ce8657039..99a20f7c12 100644 --- a/docs/en/next/tutorial-create-pages/index.html +++ b/docs/en/next/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/next/tutorial-publish-site.html b/docs/en/next/tutorial-publish-site.html index 9e88a9559e..1da8268d30 100644 --- a/docs/en/next/tutorial-publish-site.html +++ b/docs/en/next/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/next/tutorial-publish-site/index.html b/docs/en/next/tutorial-publish-site/index.html index 9e88a9559e..1da8268d30 100644 --- a/docs/en/next/tutorial-publish-site/index.html +++ b/docs/en/next/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/next/tutorial-setup.html b/docs/en/next/tutorial-setup.html index 9f53d608a1..7345f40087 100644 --- a/docs/en/next/tutorial-setup.html +++ b/docs/en/next/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/next/tutorial-setup/index.html b/docs/en/next/tutorial-setup/index.html index 9f53d608a1..7345f40087 100644 --- a/docs/en/next/tutorial-setup/index.html +++ b/docs/en/next/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/next/tutorial-version.html b/docs/en/next/tutorial-version.html index 704744a61e..d0bdbb4dcf 100644 --- a/docs/en/next/tutorial-version.html +++ b/docs/en/next/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/next/tutorial-version/index.html b/docs/en/next/tutorial-version/index.html index 704744a61e..d0bdbb4dcf 100644 --- a/docs/en/next/tutorial-version/index.html +++ b/docs/en/next/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/next/versioning.html b/docs/en/next/versioning.html index 58c40a024a..a0eb7fde35 100644 --- a/docs/en/next/versioning.html +++ b/docs/en/next/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/next/versioning/index.html b/docs/en/next/versioning/index.html
index 58c40a024a..a0eb7fde35 100644
--- a/docs/en/next/versioning/index.html
+++ b/docs/en/next/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/publishing.html b/docs/en/publishing.html
index 2feb864c31..86eb31b7dd 100644
--- a/docs/en/publishing.html
+++ b/docs/en/publishing.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/publishing/index.html b/docs/en/publishing/index.html
index 2feb864c31..86eb31b7dd 100644
--- a/docs/en/publishing/index.html
+++ b/docs/en/publishing/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+
Edit

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

Building Static HTML Pages

To create a static build of your website, run the following script from the website directory:

yarn run build # or `npm run build`
diff --git a/docs/en/search.html b/docs/en/search.html
index ed0e063801..9ddb59d7cf 100644
--- a/docs/en/search.html
+++ b/docs/en/search.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/search/index.html b/docs/en/search/index.html index ed0e063801..9ddb59d7cf 100644 --- a/docs/en/search/index.html +++ b/docs/en/search/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+
Edit

Enabling Search

Docusaurus supports search using Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.

Enabling the Search Bar

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

diff --git a/docs/en/site-config.html b/docs/en/site-config.html index 2b1272c6c5..aabcb318d1 100644 --- a/docs/en/site-config.html +++ b/docs/en/site-config.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/site-config/index.html b/docs/en/site-config/index.html index 2b1272c6c5..aabcb318d1 100644 --- a/docs/en/site-config/index.html +++ b/docs/en/site-config/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

+
Edit

siteConfig.js

A large part of the site configuration is done by editing the siteConfig.js file.

User Showcase

The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.

Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.

diff --git a/docs/en/site-creation.html b/docs/en/site-creation.html index f48746ca74..6a4c386efd 100644 --- a/docs/en/site-creation.html +++ b/docs/en/site-creation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/site-creation/index.html b/docs/en/site-creation/index.html index f48746ca74..6a4c386efd 100644 --- a/docs/en/site-creation/index.html +++ b/docs/en/site-creation/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+
Edit

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

After installation and preparation, much of the work to create a basic site for your docs is already complete.

Site Structure

Your site structure looks like the following:

diff --git a/docs/en/site-preparation.html b/docs/en/site-preparation.html index 3b6115edcb..039392d845 100644 --- a/docs/en/site-preparation.html +++ b/docs/en/site-preparation.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/site-preparation/index.html b/docs/en/site-preparation/index.html
index 3b6115edcb..039392d845 100644
--- a/docs/en/site-preparation/index.html
+++ b/docs/en/site-preparation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+
Edit

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

Directory Structure

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

root-directory
diff --git a/docs/en/translation.html b/docs/en/translation.html
index 58ff012355..a0bcca1042 100644
--- a/docs/en/translation.html
+++ b/docs/en/translation.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/translation/index.html b/docs/en/translation/index.html
index 58ff012355..a0bcca1042 100644
--- a/docs/en/translation/index.html
+++ b/docs/en/translation/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

+
Edit

Translations & Localization

Docusaurus allows for useful translation functionality using Crowdin. Documentation files written in English are uploaded to Crowdin for translation by users within a community. Top-level pages written with English strings can be translated by wrapping any strings you want to translate in a <translate> tag. Other titles and labels will also be found and properly translated.

Docusaurus Translation Configurations

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

npm run examples translations
diff --git a/docs/en/tutorial-create-new-site.html b/docs/en/tutorial-create-new-site.html
index ed1c3d66fa..c5de0c37cc 100644
--- a/docs/en/tutorial-create-new-site.html
+++ b/docs/en/tutorial-create-new-site.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/tutorial-create-new-site/index.html b/docs/en/tutorial-create-new-site/index.html index ed1c3d66fa..c5de0c37cc 100644 --- a/docs/en/tutorial-create-new-site/index.html +++ b/docs/en/tutorial-create-new-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

+
Edit

Create a New Site

In this section, we'll get our Docusaurus site up and running for local development. The process only takes a few minutes.

Docusaurus browser

Scaffold the Site

    diff --git a/docs/en/tutorial-create-pages.html b/docs/en/tutorial-create-pages.html index 2360f04834..408d19db51 100644 --- a/docs/en/tutorial-create-pages.html +++ b/docs/en/tutorial-create-pages.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/tutorial-create-pages/index.html b/docs/en/tutorial-create-pages/index.html index 2360f04834..408d19db51 100644 --- a/docs/en/tutorial-create-pages/index.html +++ b/docs/en/tutorial-create-pages/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

+
Edit

Create Pages

In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page.

Docusaurus MacBook

Create a Regular Page

    diff --git a/docs/en/tutorial-publish-site.html b/docs/en/tutorial-publish-site.html index a22c607c46..7d9cd8257b 100644 --- a/docs/en/tutorial-publish-site.html +++ b/docs/en/tutorial-publish-site.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/tutorial-publish-site/index.html b/docs/en/tutorial-publish-site/index.html index a22c607c46..7d9cd8257b 100644 --- a/docs/en/tutorial-publish-site/index.html +++ b/docs/en/tutorial-publish-site/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Publish the Site

Docusaurus Facebook

+
Edit

Publish the Site

Docusaurus Facebook

Next, we'll learn how to publish the site to the WWW for everyone to browse! For the purpose of the tutorial, we'll use GitHub Pages to host our website. But you can use any static file hosting service that you want, like Netlify, Amazon S3, etc.

Put the Site Online

    diff --git a/docs/en/tutorial-setup.html b/docs/en/tutorial-setup.html index fad87c7084..634fcccdb5 100644 --- a/docs/en/tutorial-setup.html +++ b/docs/en/tutorial-setup.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/tutorial-setup/index.html b/docs/en/tutorial-setup/index.html index fad87c7084..634fcccdb5 100644 --- a/docs/en/tutorial-setup/index.html +++ b/docs/en/tutorial-setup/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

+
Edit

Setting Up

This tutorial is geared at first-time users who want detailed instructions on how to go from zero to a Docusaurus website that has versions. Let's start!

Docusaurus campfire

Install Git

Git is a version control system for tracking changes in source code during software development and it can help you synchronize and version files between your local system and your online repository. Git for Windows includes Git Bash, a terminal application. If not already installed, see Installing Git.

diff --git a/docs/en/tutorial-version.html b/docs/en/tutorial-version.html index c891791cfb..73c9c38875 100644 --- a/docs/en/tutorial-version.html +++ b/docs/en/tutorial-version.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/tutorial-version/index.html b/docs/en/tutorial-version/index.html index c891791cfb..73c9c38875 100644 --- a/docs/en/tutorial-version/index.html +++ b/docs/en/tutorial-version/index.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

+
Edit

Add Versions

With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.

Docusaurus process

Releasing a Version

Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.

diff --git a/docs/en/versioning.html b/docs/en/versioning.html index 663756aae8..dac68c4315 100644 --- a/docs/en/versioning.html +++ b/docs/en/versioning.html @@ -80,7 +80,7 @@ }; } }); -
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions
diff --git a/docs/en/versioning/index.html b/docs/en/versioning/index.html
index 663756aae8..dac68c4315 100644
--- a/docs/en/versioning/index.html
+++ b/docs/en/versioning/index.html
@@ -80,7 +80,7 @@
                 };
               }
             });
-
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+
Edit

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

How to Create New Versions

Run the following script to generate a starter versions page listing all the site versions:

yarn examples versions