diff --git a/blog/2017/09/25/testing-rss.html b/blog/2017/09/25/testing-rss.html index 54143883bb..5ae4e17640 100644 --- a/blog/2017/09/25/testing-rss.html +++ b/blog/2017/09/25/testing-rss.html @@ -15,4 +15,4 @@ This line should never render in XML.

indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/blog/2017/09/26/adding-rss.html b/blog/2017/09/26/adding-rss.html index a2d7aec540..1784a57623 100644 --- a/blog/2017/09/26/adding-rss.html +++ b/blog/2017/09/26/adding-rss.html @@ -13,4 +13,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/blog/2017/10/24/new-version-1.0.0.html b/blog/2017/10/24/new-version-1.0.0.html index 0485db9f2d..6f15227155 100644 --- a/blog/2017/10/24/new-version-1.0.0.html +++ b/blog/2017/10/24/new-version-1.0.0.html @@ -12,4 +12,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index 87ce654da5..c4457a7222 100644 --- a/blog/index.html +++ b/blog/index.html @@ -16,4 +16,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/css/main.css b/css/main.css index 42d9c29026..578a8ccb49 100644 --- a/css/main.css +++ b/css/main.css @@ -733,11 +733,14 @@ a:hover code { text-decoration: none; } -.hljs { - font-family: "SFMono-Regular",source-code-pro,Menlo,Monaco,Consolas,"Roboto Mono","Droid Sans Mono","Liberation Mono",Consolas,"Courier New",Courier,monospace; - border-left: 4px solid #2E8555; - font-size: 13px; +pre code { + display:block; margin: 20px 0; + padding:0.5em; + border-left: 4px solid #2E8555; + font-family: "SFMono-Regular",source-code-pro,Menlo,Monaco,Consolas,"Roboto Mono","Droid Sans Mono","Liberation Mono",Consolas,"Courier New",Courier,monospace; + font-size: 13px; + overflow-x:auto; } /** GitHub **/ diff --git a/docs/en/api-pages.html b/docs/en/api-pages.html index a49d1b4e2d..bc3c7fb160 100644 --- a/docs/en/api-pages.html +++ b/docs/en/api-pages.html @@ -16,7 +16,7 @@

CompLibrary.Marked #

A React component that parses Markdown to html.

Example:

-
const Marked = CompLibrary.Marked;
+
const Marked = CompLibrary.Marked;
 
 <Marked>[Markdown syntax for a link](http://www.example.com)</Marked>
 
@@ -25,7 +25,7 @@

Padding choices: all, bottom, left, right, top.
Background choices: dark, highlight, light.

Example:

-
<Container padding={["bottom", "top"]} background="light">
+
<Container padding={["bottom", "top"]} background="light">
   ...         
 </Container>
 
@@ -42,7 +42,7 @@ Background choices: dark, highlight, lightimageLink for a link destination from clicking the image

Example:

-
<GridBlock
+
<GridBlock
   align="center"
   contents={[
     {
@@ -69,15 +69,15 @@ Background choices: dark, highlight, lightTranslating Strings #
 

When 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><translate>I like translations</translate></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.

Using Static Assets #

@@ -96,4 +96,4 @@ Background choices: dark, highlight, light \ No newline at end of file + \ No newline at end of file diff --git a/docs/en/blog.html b/docs/en/blog.html index 8d49f43137..789ed00298 100644 --- a/docs/en/blog.html +++ b/docs/en/blog.html @@ -7,7 +7,7 @@
Edit

Adding a Blog

Initial Setup #

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

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

-
headerLinks: [
+
headerLinks: [
     ...
     {blog: true, label: 'Blog'},
     ...
@@ -61,4 +61,4 @@
                 indexName: 'docusaurus',
                 inputSelector: '#search_input_react'
               });
-            
\ No newline at end of file
+            
\ No newline at end of file
diff --git a/docs/en/commands.html b/docs/en/commands.html
index a5167f527c..1bff0739e5 100644
--- a/docs/en/commands.html
+++ b/docs/en/commands.html
@@ -11,7 +11,7 @@
 
 

Running from the command line #

The scripts can be run using either Yarn or npm. If you've already gone through our Getting Started guide, you may already be familiar with the start command. It's the command that tells Docusaurus to run the docusaurus-start script which generates the site and starts up a server, and it's usually invoked like so:

-
yarn run start
+
yarn run start
 

The same script can be invoked using npm:

npm run start
@@ -84,4 +84,4 @@
                 indexName: 'docusaurus',
                 inputSelector: '#search_input_react'
               });
-            
\ No newline at end of file
+            
\ No newline at end of file
diff --git a/docs/en/custom-pages.html b/docs/en/custom-pages.html
index f537f4dfe3..071783a26b 100644
--- a/docs/en/custom-pages.html
+++ b/docs/en/custom-pages.html
@@ -14,7 +14,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 don't 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() {
@@ -31,4 +31,4 @@
                 indexName: 'docusaurus',
                 inputSelector: '#search_input_react'
               });
-            
\ No newline at end of file
+            
\ No newline at end of file
diff --git a/docs/en/doc-markdown.html b/docs/en/doc-markdown.html
index 488ea416cb..ad29742aff 100644
--- a/docs/en/doc-markdown.html
+++ b/docs/en/doc-markdown.html
@@ -11,20 +11,20 @@
 

title: The title of your document. If this field is not present, the document's title will default to it's id.

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 it's title.

For example:

-
---
-id: doc1
-title: My Document
-sidebar_label: Document
----
+
---
+id: doc1
+title: My Document
+sidebar_label: 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
-original_id: doc1
----
+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
 

Blog Posts #

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

@@ -33,32 +33,32 @@

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
-authorFBID: 100002976521003
----
+
---
+title: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
 

Extra Features #

Docusaurus supports some extra features when writing documentation in markdown.

Linking other Documents #

You can use relative urls to other documentation files which will automatically get converted to the corresponding html links when they get rendered.

Example:

-
[This links to another document](other-document.md)
+
[This links to another document](other-document.md)
 

This markdown will automatically get converted into a link to /docs/other-document.html (or the appropriately translated/versioned link) once it gets rendered.

This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct html links when they get rendered.

Linking to Images and Other Assets #

Static assets can be linked to in the same way that documents are, using relative urls. Static assets used in documents and blogs should go into docs/assets and website/blog/assets, respectively. The markdown will get converted into correct link paths so that these paths will work for documents of all languages and versions.

Example:

-
![alt-text](/docs/assets/doc-image.png)
+
![alt-text](/docs/assets/doc-image.png)
 

Generating Table of Contents #

You can make an autogenerated list of links, which can be useful as a table of contents for API docs.

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. Write your documentation using h3 headers for each function inside a code block. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

Example:

-
### `docusaurus.function(a, b)`
+
### `docusaurus.function(a, b)`
 
 Text describing my function
 
@@ -68,13 +68,13 @@ Text describing my function
 Text describing my function
 

will lead to a table of contents of the functions:

-
- `docusaurus.function(a, b)`
+
- `docusaurus.function(a, b)`
 - `docdoc(file)`
 

and each function will link to their corresponding sections in the page.

Syntax Highlighting #

Syntax highlighting is enabled by default on fenced code blocks. The language should be detected automatically, but you can sometimes get better results by specifying the language. You can do so using an info string, following the three opening backticks. The following JavaScript example...

-
```javascript
+
```javascript
 ReactDOM.render(
   <h1>Hello, world!</h1>,
   document.getElementById('root')
@@ -82,24 +82,24 @@ ReactDOM.render(
 ```
 

...would be rendered with syntax highlighting like so:

-
ReactDOM.render(
+
ReactDOM.render(
   <h1>Hello, world!</h1>,
   document.getElementById('root')
 );
 

Highlighting is provided by Highlight.js using the theme specified in your siteConfig.js file as part of the highlight key:

-
highlight: {
-  theme: 'default'
+
highlight: {
+  theme: 'default'
 }
 

You can find the full list of supported themes in the Highlight.js styles directory.

Registering additional languages #

While Highlight.js provides support for many popular languages out of the box, you may find the need to register additional language support. For these cases, we provide an escape valve by exposing the hljs constant as part of the highlight config key. This in turn allows you to call registerLanguage:

-
highlight: {
-  theme: 'default',
-  hljs: function(hljs) {
-    hljs.registerLanguage('galacticbasic', function(hljs) {
-      // ...
+
highlight: {
+  theme: 'default',
+  hljs: function(hljs) {
+    hljs.registerLanguage('galacticbasic', function(hljs) {
+      // ...
     });
   }
 }
@@ -111,4 +111,4 @@ ReactDOM.render(
                 indexName: 'docusaurus',
                 inputSelector: '#search_input_react'
               });
-            
\ No newline at end of file
+            
\ No newline at end of file
diff --git a/docs/en/installation.html b/docs/en/installation.html
index 100ae4943b..2d5b63fcab 100644
--- a/docs/en/installation.html
+++ b/docs/en/installation.html
@@ -9,7 +9,7 @@
 
  • Create a website folder in the root of your GitHub repo.

  • cd website

  • Create a package.json file with the following scripts that will be used when developing documentation with Docusaurus:

    -
    {
    +
    {
       "scripts": {
         "start": "docusaurus-start",
         "build": "docusaurus-build",
    @@ -19,7 +19,7 @@
     }
     
  • Install Docusaurus with yarn or npm

    -
    yarn add docusaurus -dev
    +
    yarn add docusaurus -dev
     

    or

    npm install --save-dev docusaurus
    @@ -32,4 +32,4 @@
                     indexName: 'docusaurus',
                     inputSelector: '#search_input_react'
                   });
    -            
    \ No newline at end of file
    +            
    \ No newline at end of file
    diff --git a/docs/en/navigation.html b/docs/en/navigation.html
    index 2327494259..b8dd6e58d3 100644
    --- a/docs/en/navigation.html
    +++ b/docs/en/navigation.html
    @@ -7,7 +7,7 @@
             
  • Edit

    Navigation and Sidebars

    New Hidden Docs #

    New markdown files within docs will show up as pages on the website. Creating a file such as "docs/getting-started.md" will enable the new page /docs/getting-started.html.

    To change the id (link name) of the file, set the id field in the markdown header. At the top of getting-started.md:

    -
    ---
    +
    ---
     id: intro
     title: Getting Started
     ---
    @@ -91,4 +91,4 @@
                     indexName: 'docusaurus',
                     inputSelector: '#search_input_react'
                   });
    -            
    \ No newline at end of file
    +            
    \ No newline at end of file
    diff --git a/docs/en/publishing.html b/docs/en/publishing.html
    index 923e13a473..a2df97388f 100644
    --- a/docs/en/publishing.html
    +++ b/docs/en/publishing.html
    @@ -7,7 +7,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.

    Building Static HTML Pages #

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

    -
    npm run build
    +
    npm run build
     

    or

    yarn run build
    @@ -70,4 +70,4 @@
                     indexName: 'docusaurus',
                     inputSelector: '#search_input_react'
                   });
    -            
    \ No newline at end of file
    +            
    \ No newline at end of file
    diff --git a/docs/en/search.html b/docs/en/search.html
    index 6bb17d7105..0bffb6d0e3 100644
    --- a/docs/en/search.html
    +++ b/docs/en/search.html
    @@ -7,7 +7,7 @@
             
    Edit

    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",
    @@ -18,7 +18,7 @@
     

    Extra Search Options #

    You 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: {
         ...
    @@ -32,7 +32,7 @@
     

    Controlling the Location of the Search Bar #

    By 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: [
         {...}
    @@ -54,4 +54,4 @@
                     indexName: 'docusaurus',
                     inputSelector: '#search_input_react'
                   });
    -            
    \ No newline at end of file
    +            
    \ No newline at end of file
    diff --git a/docs/en/site-config.html b/docs/en/site-config.html
    index 42c593a7bb..19c869d228 100644
    --- a/docs/en/site-config.html
    +++ b/docs/en/site-config.html
    @@ -19,7 +19,7 @@
     

    noIndex - Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site.

    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
    @@ -64,7 +64,7 @@
     

    scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

    Users can also add their own custom fields if they wish to provide some data across different files.

    Example siteConfig.js with all fields #

    -
    const users = [
    +
    const users = [
       {
         caption: "User1",
         image: "/test-site/img/docusaurus.svg",
    @@ -133,4 +133,4 @@
                     indexName: 'docusaurus',
                     inputSelector: '#search_input_react'
                   });
    -            
    \ No newline at end of file
    +            
    \ No newline at end of file
    diff --git a/docs/en/site-creation.html b/docs/en/site-creation.html
    index be231dcb4b..419852d34c 100644
    --- a/docs/en/site-creation.html
    +++ b/docs/en/site-creation.html
    @@ -10,7 +10,7 @@
     

    Preparation created a sample site for you to see Docusaurus in action. However, it also provided the infrastructure that will be used as you are developing your own site.

    Site Structure #

    After loading the example site, you should see a structure in your repo that looks similar to:

    -
    project-repo/
    +
    project-repo/
       docs/
         doc1.md
       website/
    @@ -47,4 +47,4 @@ yarn run start # 
    \ No newline at end of file
    +            
    \ No newline at end of file
    diff --git a/docs/en/site-preparation.html b/docs/en/site-preparation.html
    index 537a9c0e44..9f5f5d739e 100644
    --- a/docs/en/site-preparation.html
    +++ b/docs/en/site-preparation.html
    @@ -12,7 +12,7 @@
     

    Verifying Installation #

    1. Generate the files for the example site by running examples using yarn or npm.

      -
      npm run examples
      +
      npm run examples
       

      or

      yarn run examples
      @@ -59,4 +59,4 @@ docs-examples-from-docusaurus/...
                       indexName: 'docusaurus',
                       inputSelector: '#search_input_react'
                     });
      -            
      \ No newline at end of file
      +            
      \ No newline at end of file
      diff --git a/docs/en/translation.html b/docs/en/translation.html
      index a90fbec040..57fa75776b 100644
      --- a/docs/en/translation.html
      +++ b/docs/en/translation.html
      @@ -7,7 +7,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.

    Docusaurus Translation Configurations #

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

    -
    npm run examples translations
    +
    npm run examples translations
     

    or

    yarn examples translations
    @@ -26,7 +26,7 @@ crowdin.yaml
     

    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>
    @@ -35,14 +35,14 @@ const translate = require("../../server/translate.js").translate;
     ...
     

    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>
     

    Gathering Strings to Translate #

    The strings within localized Pages must be extracted and provided to Crowdin.

    Add the following script to your package.json file:

    -
    ...
    +
    ...
     "scripts": {
       "write-translations": "docusaurus-write-translations"
     },
    @@ -77,7 +77,7 @@ const translate = require("../../server/translate.js").translate;
     
     

    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, Behasa 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
    @@ -102,7 +102,7 @@ const translate = require("../../server/translate.js").translate;
     

    Manual File Sync #

    You 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": "export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID;
       export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml upload sources --auto-update -b master",
       "crowdin-download": "export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID;
    @@ -114,7 +114,7 @@ const translate = require("../../server/translate.js").translate;
     

    Automated File Sync Using CircleCI #

    You 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:
    @@ -152,7 +152,7 @@ const translate = require("../../server/translate.js").translate;
     

    TODO - This section needs to be fleshed out.

    OLD -

    If 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
    @@ -165,4 +165,4 @@ const translate = require("../../server/translate.js").translate;
                     indexName: 'docusaurus',
                     inputSelector: '#search_input_react'
                   });
    -            
    \ No newline at end of file
    +            
    \ No newline at end of file
    diff --git a/docs/en/versioning.html b/docs/en/versioning.html
    index de3479cffe..4a261cfab1 100644
    --- a/docs/en/versioning.html
    +++ b/docs/en/versioning.html
    @@ -7,14 +7,14 @@
             
    Edit

    Versioning

    Users 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 #

    Add the following script to your package.json file:

    -
    ...
    +
    ...
     "scripts": {
       "version": "docusaurus-version"
     },
     ...
     

    Run the script with a command line argument of the version you wish to create. e.g.,

    -
    npm run version 1.0.0
    +
    npm 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, and the site will display the version number next to the title in the header.

    @@ -33,14 +33,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 Versions #

    To 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.,

    -
    npm run rename-version 1.0.0 1.0.1
    +
    npm run rename-version 1.0.0 1.0.1
     

    Versioning and Translations #

    If 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.

    @@ -51,4 +51,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/en/help.html b/en/help.html index 96672b35dc..01293c88c3 100644 --- a/en/help.html +++ b/en/help.html @@ -11,4 +11,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/en/index.html b/en/index.html index b788b63d35..4764f11594 100644 --- a/en/index.html +++ b/en/index.html @@ -23,4 +23,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/en/users.html b/en/users.html index 5cb3449bab..8d71e08be3 100644 --- a/en/users.html +++ b/en/users.html @@ -5,4 +5,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/help.html b/help.html index 96672b35dc..01293c88c3 100644 --- a/help.html +++ b/help.html @@ -11,4 +11,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/index.html b/index.html index b788b63d35..4764f11594 100644 --- a/index.html +++ b/index.html @@ -23,4 +23,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file diff --git a/users.html b/users.html index 5cb3449bab..8d71e08be3 100644 --- a/users.html +++ b/users.html @@ -5,4 +5,4 @@ indexName: 'docusaurus', inputSelector: '#search_input_react' }); - \ No newline at end of file + \ No newline at end of file