Enabling Search
Docusaurus supports search using Algolia DocSearch. Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.
Enabling the Search Bar
Enter your search-only API key and index name into siteConfig.js
in the algolia
section to enable search for your site.
const siteConfig = {
+const siteConfig = {
...
algolia: {
apiKey: "my-search-only-api-key-1234",
@@ -61,7 +61,7 @@
Extra Search OptionsYou can also specify extra search options used by Algolia by using an algoliaOptions
field in algolia
. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.
-const siteConfig = {
+const siteConfig = {
...
algolia: {
...
@@ -75,7 +75,7 @@
Controlling the Location of the Search BarBy default, the search bar will be the rightmost element in the top navigation bar.
If you want to change the default location, add the searchBar
flag in the headerLinks
field of siteConfig.js
in your desired location. For example, you may want the search bar in between your internal and external links.
-const siteConfig = {
+const siteConfig = {
...
headerLinks: [
{...}
diff --git a/docs/en/1.0.11/search/index.html b/docs/en/1.0.11/search/index.html
index c298fb75dc..3b40509d6f 100644
--- a/docs/en/1.0.11/search/index.html
+++ b/docs/en/1.0.11/search/index.html
@@ -50,7 +50,7 @@
Enabling Search
Docusaurus supports search using Algolia DocSearch. Once you have set up your site, enter your site information to have Algolia crawl your website's documentation pages. Algolia will then send you an API key and index name for your site.
Enabling the Search Bar
Enter your search-only API key and index name into siteConfig.js
in the algolia
section to enable search for your site.
const siteConfig = {
+const siteConfig = {
...
algolia: {
apiKey: "my-search-only-api-key-1234",
@@ -61,7 +61,7 @@
Extra Search OptionsYou can also specify extra search options used by Algolia by using an algoliaOptions
field in algolia
. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.
-const siteConfig = {
+const siteConfig = {
...
algolia: {
...
@@ -75,7 +75,7 @@
Controlling the Location of the Search BarBy default, the search bar will be the rightmost element in the top navigation bar.
If you want to change the default location, add the searchBar
flag in the headerLinks
field of siteConfig.js
in your desired location. For example, you may want the search bar in between your internal and external links.
-const siteConfig = {
+const siteConfig = {
...
headerLinks: [
{...}
diff --git a/docs/en/1.0.11/site-config.html b/docs/en/1.0.11/site-config.html
index b15d6cb7eb..48a85d875e 100644
--- a/docs/en/1.0.11/site-config.html
+++ b/docs/en/1.0.11/site-config.html
@@ -66,7 +66,7 @@
headerIcon
- url for icon used in header navigation bar.
headerLinks
- Links that will be used in the header navigation bar. The label
field of each object will be the link text and will also be translated for each language.
Example Usage:
-headerLinks: [
+headerLinks: [
// Links to document with id doc1 for current language/version
{ doc: "doc1", label: "Getting Started" },
// Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
@@ -97,9 +97,9 @@
blogSidebarCount
- Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.
cname
- The CNAME for your website. It will go into a CNAME
file when your site it built.
customDocsPath
- By default, Docusaurus expects your documentation to be in a directory called docs
. This directory is at the same level as the website
directory (i.e., not inside the website
directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md
files must still reside in a flat hierarchy. You cannot have your documents in nested directories.
-customDocsPath: "docs/site"
+customDocsPath: "docs/site"
-customDocsPath: "website-docs"
+customDocsPath: "website-docs"
disableHeaderTitle
- An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true
.
disableTitleTagline
- An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline
. Set to true
to make page titles just Title
.
diff --git a/docs/en/1.0.11/site-config/index.html b/docs/en/1.0.11/site-config/index.html
index b15d6cb7eb..48a85d875e 100644
--- a/docs/en/1.0.11/site-config/index.html
+++ b/docs/en/1.0.11/site-config/index.html
@@ -66,7 +66,7 @@
headerIcon
- url for icon used in header navigation bar.
headerLinks
- Links that will be used in the header navigation bar. The label
field of each object will be the link text and will also be translated for each language.
Example Usage:
-headerLinks: [
+headerLinks: [
// Links to document with id doc1 for current language/version
{ doc: "doc1", label: "Getting Started" },
// Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
@@ -97,9 +97,9 @@
blogSidebarCount
- Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.
cname
- The CNAME for your website. It will go into a CNAME
file when your site it built.
customDocsPath
- By default, Docusaurus expects your documentation to be in a directory called docs
. This directory is at the same level as the website
directory (i.e., not inside the website
directory). You can specify a custom path to your documentation with this field. Note that all of your documentation *.md
files must still reside in a flat hierarchy. You cannot have your documents in nested directories.
-customDocsPath: "docs/site"
+customDocsPath: "docs/site"
-customDocsPath: "website-docs"
+customDocsPath: "website-docs"
disableHeaderTitle
- An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to true
.
disableTitleTagline
- An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as Title • Tagline
. Set to true
to make page titles just Title
.
diff --git a/docs/en/1.0.11/site-creation.html b/docs/en/1.0.11/site-creation.html
index bd5a15c9fc..27b21eb2da 100644
--- a/docs/en/1.0.11/site-creation.html
+++ b/docs/en/1.0.11/site-creation.html
@@ -51,7 +51,7 @@
After installation and preparation, much of the work to create a basic site for your docs is already complete.
Site StructureYour site structure looks like the following:
-root-of-repo
+root-of-repo
├── docs
└── website
│ └── blog
diff --git a/docs/en/1.0.11/site-creation/index.html b/docs/en/1.0.11/site-creation/index.html
index bd5a15c9fc..27b21eb2da 100644
--- a/docs/en/1.0.11/site-creation/index.html
+++ b/docs/en/1.0.11/site-creation/index.html
@@ -51,7 +51,7 @@
After installation and preparation, much of the work to create a basic site for your docs is already complete.
Site StructureYour site structure looks like the following:
-root-of-repo
+root-of-repo
├── docs
└── website
│ └── blog
diff --git a/docs/en/1.0.11/site-preparation.html b/docs/en/1.0.11/site-preparation.html
index a53f26c107..1370443646 100644
--- a/docs/en/1.0.11/site-preparation.html
+++ b/docs/en/1.0.11/site-preparation.html
@@ -50,7 +50,7 @@
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-of-repo
+root-of-repo
├── docs-examples-from-docusaurus
│ └── doc1.md
│ └── doc2.md
diff --git a/docs/en/1.0.11/site-preparation/index.html b/docs/en/1.0.11/site-preparation/index.html
index a53f26c107..1370443646 100644
--- a/docs/en/1.0.11/site-preparation/index.html
+++ b/docs/en/1.0.11/site-preparation/index.html
@@ -50,7 +50,7 @@
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-of-repo
+root-of-repo
├── docs-examples-from-docusaurus
│ └── doc1.md
│ └── doc2.md
diff --git a/docs/en/1.0.11/translation.html b/docs/en/1.0.11/translation.html
index 06fb174241..169377dc56 100644
--- a/docs/en/1.0.11/translation.html
+++ b/docs/en/1.0.11/translation.html
@@ -76,7 +76,7 @@ languages.js
Pages allow you to customize layout and specific content of pages like a custom index page or help page.
Pages with text that you want translated should be placed in website/pages/en
folder.
Wrap strings you want translated in a <translate>
tag, and add the following require
statement to the top of the file:
-...
+...
const translate = require("../../server/translate.js").translate;
...
<h2>
@@ -85,7 +85,7 @@ languages.js
...
You can also include an optional description attribute to give more context to a translator about how to translate the string:
-<p>
+<p>
<translate desc="flower, not verb">Rose</translate>
<p>
@@ -95,7 +95,7 @@ languages.js
Gathering Strings to TranslateThe strings within localized Pages must be extracted and provided to Crowdin.
Add the following script to your website/package.json
file, if it does not exist already:
-...
+...
"scripts": {
"write-translations": "docusaurus-write-translations"
},
@@ -133,7 +133,7 @@ languages.js
The example below can be automatically generated by the Docusaurus cli with the examples
script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.
Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.
-project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
+project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
api_key_env: CROWDIN_DOCUSAURUS_API_KEY
base_path: "./"
preserve_hierarchy: true
@@ -158,7 +158,7 @@ languages.js
Setup the Crowdin ScriptsYou will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs
as well as translatable strings in website/i18n/en.json
. (These strings can be generated by running yarn write-translations
.)
You can add the following to your package.json
to manually trigger Crowdin.
-"scripts": {
+"scripts": {
"crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
"crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
},
@@ -183,7 +183,7 @@ languages.js
Automated File Sync Using CircleCIYou can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.
First, update the circle.yml
file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml
file:
-machine:
+machine:
node:
version: 6.10.3
npm:
@@ -219,7 +219,7 @@ languages.js
If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml
file. The only difference is that you must set project_identifier
and api_key
values in the crowdin.yaml
file since you will not have Circle environment variables set up.
Versioned TranslationsIf you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml
file:
- -
+ -
source: '/website/versioned_docs/**/*.md'
translation: '/website/translated_docs/%locale%/**/%original_file_name%'
languages_mapping: *anchor
diff --git a/docs/en/1.0.11/translation/index.html b/docs/en/1.0.11/translation/index.html
index 06fb174241..169377dc56 100644
--- a/docs/en/1.0.11/translation/index.html
+++ b/docs/en/1.0.11/translation/index.html
@@ -76,7 +76,7 @@ languages.js
Pages allow you to customize layout and specific content of pages like a custom index page or help page.
Pages with text that you want translated should be placed in website/pages/en
folder.
Wrap strings you want translated in a <translate>
tag, and add the following require
statement to the top of the file:
-...
+...
const translate = require("../../server/translate.js").translate;
...
<h2>
@@ -85,7 +85,7 @@ languages.js
...
You can also include an optional description attribute to give more context to a translator about how to translate the string:
-<p>
+<p>
<translate desc="flower, not verb">Rose</translate>
<p>
@@ -95,7 +95,7 @@ languages.js
Gathering Strings to TranslateThe strings within localized Pages must be extracted and provided to Crowdin.
Add the following script to your website/package.json
file, if it does not exist already:
-...
+...
"scripts": {
"write-translations": "docusaurus-write-translations"
},
@@ -133,7 +133,7 @@ languages.js
The example below can be automatically generated by the Docusaurus cli with the examples
script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded.
Below is an example Crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Bahasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional.
-project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
+project_identifier_env: CROWDIN_DOCUSAURUS_PROJECT_ID
api_key_env: CROWDIN_DOCUSAURUS_API_KEY
base_path: "./"
preserve_hierarchy: true
@@ -158,7 +158,7 @@ languages.js
Setup the Crowdin ScriptsYou will want to manually sync your files to and from Crowdin. The sync process will upload any markdown files in /docs
as well as translatable strings in website/i18n/en.json
. (These strings can be generated by running yarn write-translations
.)
You can add the following to your package.json
to manually trigger Crowdin.
-"scripts": {
+"scripts": {
"crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
"crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
},
@@ -183,7 +183,7 @@ languages.js
Automated File Sync Using CircleCIYou can automate pulling down and uploading translations for your files using the CircleCI web continuous integration service.
First, update the circle.yml
file in your project directory to include steps to upload English files to be translated and download translated files using the Crowdin CLI. Here is an example circle.yml
file:
-machine:
+machine:
node:
version: 6.10.3
npm:
@@ -219,7 +219,7 @@ languages.js
If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml
file. The only difference is that you must set project_identifier
and api_key
values in the crowdin.yaml
file since you will not have Circle environment variables set up.
Versioned TranslationsIf you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml
file:
- -
+ -
source: '/website/versioned_docs/**/*.md'
translation: '/website/translated_docs/%locale%/**/%original_file_name%'
languages_mapping: *anchor
diff --git a/docs/en/1.0.11/versioning.html b/docs/en/1.0.11/versioning.html
index fc903eb43f..5298deba0c 100644
--- a/docs/en/1.0.11/versioning.html
+++ b/docs/en/1.0.11/versioning.html
@@ -50,19 +50,19 @@
Versioning
You can use the version
script to cut a new documentation version based on the latest content in the docs
folder. That specific set of documentation will then be preserved and accessible even as the documentation in the docs
folder 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
+yarn examples versions
This creates the pages/en/versions.js
file.
You can edit this file later on to customize how you display the versions.
Add the following script to your package.json
file if it doesn't already exist:
-...
+...
"scripts": {
"version": "docusaurus-version"
},
...
Run the script with a command line argument of the version you wish to create. e.g.,
-yarn run version 1.0.0
+yarn run version 1.0.0
This will preserve all documents currently in the docs
folder and make them available as documentation for version 1.0.0
.
If, for example, you ran the version script with 1.0.0
as the version number, version 1.0.0
is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.
@@ -81,14 +81,14 @@
For example, a document with the original id doc1
exists for the latest version, 1.0.0
, and has the same content as the document with the id doc1
in the docs
folder. When a new version 2.0.0
is created, the file for doc1
will not be copied into versioned_docs/version-2.0.0/
. There will still be a page for docs/2.0.0/doc1.html
, but it will use the file from version 1.0.0
.
Renaming Existing VersionsTo rename an existing version number to something else, first make sure the following script is in your package.json
file:
-...
+...
"scripts": {
"rename-version": "docusaurus-rename-version"
},
...
Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,
-yarn run rename-version 1.0.0 1.0.1
+yarn run rename-version 1.0.0 1.0.1
Versioning and TranslationsIf you wish to use versioning and translations features, the crowdin.yaml
file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/
. For more information, check out the translations guide.
diff --git a/docs/en/1.0.11/versioning/index.html b/docs/en/1.0.11/versioning/index.html
index fc903eb43f..5298deba0c 100644
--- a/docs/en/1.0.11/versioning/index.html
+++ b/docs/en/1.0.11/versioning/index.html
@@ -50,19 +50,19 @@
Versioning
You can use the version
script to cut a new documentation version based on the latest content in the docs
folder. That specific set of documentation will then be preserved and accessible even as the documentation in the docs
folder 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
+yarn examples versions
This creates the pages/en/versions.js
file.
You can edit this file later on to customize how you display the versions.
Add the following script to your package.json
file if it doesn't already exist:
-...
+...
"scripts": {
"version": "docusaurus-version"
},
...
Run the script with a command line argument of the version you wish to create. e.g.,
-yarn run version 1.0.0
+yarn run version 1.0.0
This will preserve all documents currently in the docs
folder and make them available as documentation for version 1.0.0
.
If, for example, you ran the version script with 1.0.0
as the version number, version 1.0.0
is considered the latest release version for your project. The site will display the version number next to the title in the header. This version number links to a versions page that you created earlier.
@@ -81,14 +81,14 @@
For example, a document with the original id doc1
exists for the latest version, 1.0.0
, and has the same content as the document with the id doc1
in the docs
folder. When a new version 2.0.0
is created, the file for doc1
will not be copied into versioned_docs/version-2.0.0/
. There will still be a page for docs/2.0.0/doc1.html
, but it will use the file from version 1.0.0
.
Renaming Existing VersionsTo rename an existing version number to something else, first make sure the following script is in your package.json
file:
-...
+...
"scripts": {
"rename-version": "docusaurus-rename-version"
},
...
Run the script with command line arguments of first, the current version name, then second, the new version name. e.g.,
-yarn run rename-version 1.0.0 1.0.1
+yarn run rename-version 1.0.0 1.0.1
Versioning and TranslationsIf you wish to use versioning and translations features, the crowdin.yaml
file should be set up to upload and download versioned documents to and from Crowdin for translation. Translated, versioned files will go into the folder translated_docs/${language}/version-${version}/
. For more information, check out the translations guide.
diff --git a/docs/en/1.0.12/api-pages.html b/docs/en/1.0.12/api-pages.html
index 02a82a81fe..05dfe49912 100644
--- a/docs/en/1.0.12/api-pages.html
+++ b/docs/en/1.0.12/api-pages.html
@@ -59,7 +59,7 @@
CompLibrary.MarkdownBlock
A React component that parses markdown and renders to HTML.
Example:
-const MarkdownBlock = CompLibrary.MarkdownBlock;
+const MarkdownBlock = CompLibrary.MarkdownBlock;
<MarkdownBlock>
[Markdown syntax for a link](http://www.example.com)
@@ -79,7 +79,7 @@
Example
-<Container
+<Container
padding={['bottom', 'top']}
background="light"
className="myCustomClass">
@@ -144,19 +144,19 @@
Translating StringsWhen translations are enabled, any pages inside website/pages/en
will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js
file. E.g. The url for a French page of website/pages/en/help.js
would be found at ${baseUrl}fr/help.html
.
When writing pages that you wish to translate, wrap any strings to be translated inside a <translate>
tag. e.g.,
-<p>
+<p>
<translate>I like translations</translate>
</p>
You can also provide an optional description attribute to provide context for translators. e.g,
-<a href="/community">
+<a href="/community">
<translate desc="Footer link to page referring to community GitHub and Slack">
Community
</translate>
</a>
Add the following require statement as well:
-const translate = require('../../server/translate.js').translate;
+const translate = require('../../server/translate.js').translate;
Note that this path is valid for files inside pages/en
and should be adjusted accordingly if files are in different locations, as discussed above.
diff --git a/docs/en/1.0.12/api-pages/index.html b/docs/en/1.0.12/api-pages/index.html
index 02a82a81fe..05dfe49912 100644
--- a/docs/en/1.0.12/api-pages/index.html
+++ b/docs/en/1.0.12/api-pages/index.html
@@ -59,7 +59,7 @@
Using Static AssetsCompLibrary.MarkdownBlock
A React component that parses markdown and renders to HTML.
Example:
-const MarkdownBlock = CompLibrary.MarkdownBlock;
+const MarkdownBlock = CompLibrary.MarkdownBlock;
<MarkdownBlock>
[Markdown syntax for a link](http://www.example.com)
@@ -79,7 +79,7 @@
Example
-<Container
+<Container
padding={['bottom', 'top']}
background="light"
className="myCustomClass">
@@ -144,19 +144,19 @@
Translating StringsWhen translations are enabled, any pages inside website/pages/en
will be translated for all enabled languages. Urls for non-English pages will use their language tags as specified in the languages.js
file. E.g. The url for a French page of website/pages/en/help.js
would be found at ${baseUrl}fr/help.html
.
When writing pages that you wish to translate, wrap any strings to be translated inside a <translate>
tag. e.g.,
-<p>
+<p>
<translate>I like translations</translate>
</p>
You can also provide an optional description attribute to provide context for translators. e.g,
-<a href="/community">
+<a href="/community">
<translate desc="Footer link to page referring to community GitHub and Slack">
Community
</translate>
</a>
Add the following require statement as well:
-const translate = require('../../server/translate.js').translate;
+const translate = require('../../server/translate.js').translate;
Note that this path is valid for files inside pages/en
and should be adjusted accordingly if files are in different locations, as discussed above.
diff --git a/docs/en/1.0.12/commands.html b/docs/en/1.0.12/commands.html
index 3d15d2eaaf..408caa1bbf 100644
--- a/docs/en/1.0.12/commands.html
+++ b/docs/en/1.0.12/commands.html
@@ -100,7 +100,7 @@
Using Static AssetsUSE_SSH
: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
e.g.,
-GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
The following environment variables are set by CircleCI during the build process.
diff --git a/docs/en/1.0.12/commands/index.html b/docs/en/1.0.12/commands/index.html
index 3d15d2eaaf..408caa1bbf 100644
--- a/docs/en/1.0.12/commands/index.html
+++ b/docs/en/1.0.12/commands/index.html
@@ -100,7 +100,7 @@
USE_SSH
: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
e.g.,
-GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
The following environment variables are set by CircleCI during the build process.
diff --git a/docs/en/1.0.12/custom-pages.html b/docs/en/1.0.12/custom-pages.html
index 5a40c99785..4b5ab7a080 100644
--- a/docs/en/1.0.12/custom-pages.html
+++ b/docs/en/1.0.12/custom-pages.html
@@ -53,7 +53,7 @@
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.
Adding Other Custom PagesDocusaurus provides some simple example pages in the website/pages/en
directory, including index.js
, users.js
, and help.js
. These are good examples to showcase how to create a custom page for Docusaurus.
-
root-of-repo
+root-of-repo
├── docs
└── website
│ └── blog
@@ -85,7 +85,7 @@
Some suggestions for links you may want to provide: documentation, API, Twitter, Discord, Facebook groups, Stack Overflow, GitHub, etc.
Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.
If you do not want a footer for your site, change the render
function of core/Footer.js
to return null
. e.g.,
-const React = require("react");
+const React = require("react");
class Footer extends React.Component {
render() {
diff --git a/docs/en/1.0.12/custom-pages/index.html b/docs/en/1.0.12/custom-pages/index.html
index 5a40c99785..4b5ab7a080 100644
--- a/docs/en/1.0.12/custom-pages/index.html
+++ b/docs/en/1.0.12/custom-pages/index.html
@@ -53,7 +53,7 @@
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.
Adding Other Custom PagesDocusaurus provides some simple example pages in the website/pages/en
directory, including index.js
, users.js
, and help.js
. These are good examples to showcase how to create a custom page for Docusaurus.
-root-of-repo
+root-of-repo
├── docs
└── website
│ └── blog
@@ -85,7 +85,7 @@
Some suggestions for links you may want to provide: documentation, API, Twitter, Discord, Facebook groups, Stack Overflow, GitHub, etc.
Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static html pages you include.
If you do not want a footer for your site, change the render
function of core/Footer.js
to return null
. e.g.,
-const React = require("react");
+const React = require("react");
class Footer extends React.Component {
render() {
diff --git a/docs/en/1.0.12/doc-markdown.html b/docs/en/1.0.12/doc-markdown.html
index a74c8fd05d..63d0c64107 100644
--- a/docs/en/1.0.12/doc-markdown.html
+++ b/docs/en/1.0.12/doc-markdown.html
@@ -55,7 +55,7 @@
hide_title
: Whether to hide the title at the top of the doc.
sidebar_label
: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label
will default to its title
.
For example:
----
+---
id: doc1
title: My Document
sidebar_label: Document
@@ -63,7 +63,7 @@ title: My Document
Versioned documents have their ids altered to include the version number when they get copied. The new id
is version-${version}-${id}
where ${version}
is the version number of that document and ${id}
is the original id
. Additionally, versioned documents get an added original_id
field with the original document id.
For example:
----
+---
id: version-1.0.0-doc1
title: My Document
sidebar_label: Document
@@ -72,7 +72,7 @@ sidebar_label: Document
custom_edit_url
: The url for editing this document. If this field is not present, the document's edit url will fallback to editUrl
from optional fields of siteConfig.js
. See siteConfig.js docs for more information.
For example:
----
+---
id: doc-markdown
title: Markdown Features
custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
@@ -85,7 +85,7 @@ title: Markdown Features
authorURL
: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.
authorFBID
: The author's Facebook id, used only to get the author's profile picture to display with the blog post. If this field is omitted, no author picture will be shown for the blog post.
For example:
----
+---
title: My First Blog Post
author: Frank Li
authorURL: http://twitter.com/franchementli
@@ -97,20 +97,20 @@ authorURL: http://twitter.com/franchementli