From 94a93d89687387278309c2826bb1e6694b83aced Mon Sep 17 00:00:00 2001 From: Facebook GitHub Bot Date: Tue, 24 Oct 2017 17:52:08 +0000 Subject: [PATCH] update website [ci skip] --- blog/2017/09/25/testing-rss.html | 10 +- blog/2017/09/26/adding-rss.html | 11 +- blog/index.html | 9 +- css/main.css | 150 +-------------------- docs/api-pages.html | 2 +- docs/blog.html | 2 +- docs/commands.html | 2 +- docs/custom-pages.html | 2 +- docs/doc-markdown.html | 2 +- docs/en/api-pages.html | 116 ++++++++++++----- docs/en/blog.html | 67 +++++++--- docs/en/commands.html | 79 +++++++++++- docs/en/custom-pages.html | 30 +++-- docs/en/doc-markdown.html | 118 ++++++++++++++--- docs/en/installation.html | 34 +++-- docs/en/navigation.html | 124 ++++++++++++------ docs/en/publishing.html | 72 +++++++++-- docs/en/search.html | 75 ++++++----- docs/en/site-config.html | 187 +++++++++++++++++---------- docs/en/site-creation.html | 49 +++++-- docs/en/site-preparation.html | 59 +++++++-- docs/en/translation.html | 215 +++++++++++++++++++++---------- docs/en/versioning.html | 54 ++++++-- docs/installation.html | 2 +- docs/navigation.html | 2 +- docs/publishing.html | 2 +- docs/search.html | 2 +- docs/site-config.html | 2 +- docs/site-creation.html | 2 +- docs/site-preparation.html | 2 +- docs/translation.html | 2 +- docs/versioning.html | 2 +- en/help.html | 10 +- en/index.html | 22 +++- en/users.html | 4 +- help.html | 10 +- index.html | 22 +++- js/webplayer.js | 73 ----------- users.html | 4 +- 39 files changed, 1034 insertions(+), 598 deletions(-) delete mode 100644 js/webplayer.js diff --git a/blog/2017/09/25/testing-rss.html b/blog/2017/09/25/testing-rss.html index ab206b066e..5796b37aa2 100644 --- a/blog/2017/09/25/testing-rss.html +++ b/blog/2017/09/25/testing-rss.html @@ -1,16 +1,18 @@ -Adding RSS Support · Docusaurus

Docusaurus

Adding RSS Support

September 25, 2017

Eric Nakagawa

1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

+

This should be truncated. <!--truncate--> -This line should never render in XML.

Recent Posts
\ 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 b13d03fcfb..457c8b4ffd 100644 --- a/blog/2017/09/26/adding-rss.html +++ b/blog/2017/09/26/adding-rss.html @@ -1,16 +1,17 @@ -Adding RSS Support · Docusaurus

Docusaurus

\ No newline at end of file + \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index 7684e786ee..ac875448a9 100644 --- a/blog/index.html +++ b/blog/index.html @@ -1,14 +1,17 @@ -Blog · Docusaurus

Docusaurus

\ No newline at end of file + \ No newline at end of file diff --git a/css/main.css b/css/main.css index 4dcbc54d0c..42d9c29026 100644 --- a/css/main.css +++ b/css/main.css @@ -724,8 +724,8 @@ a code, .mainContainer .wrapper a:focus code { color: #2E8555; font-family: "SFMono-Regular",source-code-pro,Menlo,Monaco,Consolas,"Roboto Mono","Droid Sans Mono","Liberation Mono",Consolas,"Courier New",Courier,monospace; - font-weight: 300; } + a code { text-decoration: underline; } @@ -733,121 +733,11 @@ a:hover code { text-decoration: none; } -.prism { - white-space: pre-wrap; +.hljs { 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; - line-height: 20px; border-left: 4px solid #2E8555; - overflow-x: scroll; - -webkit-overflow-scrolling: touch; - padding: 15px 10px; + font-size: 13px; margin: 20px 0; - background-color: rgba(46, 133, 85, 0.03); -} - -.prism + .prism { - margin-top: 14px; -} -.prism table { - background: none; - border: none; -} -.prism table tbody tr { - background: none; - display: flex; - flex-flow: row nowrap; -} -.highlighter-rouge .prism table tbody tr td { - display: block; - flex: 1 1; -} -.highlighter-rouge .prism table tbody tr td.gutter { - border-right: 1px solid #005469; - color: #006883; - margin-right: 10px; - max-width: 40px; - padding-right: 10px; -} -.highlighter-rouge .prism table tbody tr td.gutter pre { - max-width: 20px; -} -/* Inline code */ -:not(pre) > code[class*="language-"] { - padding: .1em; - border-radius: .3em; - white-space: normal; -} - -.token.comment, -.token.prolog, -.token.doctype, -.token.cdata { - color: slategray; -} - -.token.punctuation { - color: #999; -} - -.namespace { - opacity: .7; -} - -.token.property, -.token.tag, -.token.boolean, -.token.number, -.token.constant, -.token.symbol, -.token.deleted { - color: #905; -} - -.token.selector, -.token.attr-name, -.token.string, -.token.char, -.token.builtin, -.token.inserted { - color: #690; -} - -.token.operator, -.token.entity, -.token.url, -.language-css .token.string, -.style .token.string { - color: #a67f59; - background: hsla(0, 0%, 100%, .5); -} - -.token.atrule, -.token.attr-value, -.token.keyword { - color: #07a; -} - -.token.function { - color: #DD4A68; -} - -.token.regex, -.token.important, -.token.variable { - color: #e90; -} - -.token.important, -.token.bold { - font-weight: bold; -} -.token.italic { - font-style: italic; -} - -.token.entity { - cursor: help; } /** GitHub **/ @@ -2012,37 +1902,3 @@ footer .copyright { } } - -/** Web player **/ -.web-player > iframe { - display: none; -} - -.web-player > .prism { - display: none; -} - -.web-player.desktop > iframe { - display: block; } - -.web-player.mobile > .prism { - display: block; } - -.token.keyword { - color: #1990b8; -} - -.token.string, -.token.regex { - color: #2f9c0a; -} - -.token.boolean, -.token.number { - color: #c92c2c; -} - -.token.comment { - color: #7d8b99; -} - diff --git a/docs/api-pages.html b/docs/api-pages.html index 4f54d111df..8ea175508f 100644 --- a/docs/api-pages.html +++ b/docs/api-pages.html @@ -1,4 +1,4 @@ -Docusaurus · Easy to Maintain Open Source Documentation Websites

Docusaurus

Edit

Pages and Styles

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

+

Urls for Pages #

+

Any .js files in website/pages will be rendered to static html using the path of the file after "pages". Files in website/pages/en will also get copied out into pages and will OVERRIDE any files of the same name in pages. For example, the page for the website/pages/en/help.js file will be found at the url ${baseUrl}en/help.js as well as the url ${baseUrl}help.js, where ${baseUrl} is the baseUrl field set in your siteConfig.js file.

+

Page Require Paths #

+

Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages folder are temporarily copied into node_modules/docusaurus when rendering to static html. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to "../../core/CompLibrary.js" to import the provided components.

+

What this means to the user is that if you wish to use the CompLibrary module, make sure the require path is set correctly. For example, a page at page/mypage.js would use a path "../core/CompLibrary.js".

+

If you wish to use your own components inside the website folder, use process.cwd() which will refer to the website folder to construct require paths. For example, if you add a component to website/core/mycomponent.js, you can use the require path, "process.cwd() + /core/mycomponent.js".

+

Provided Components #

+

Docusaurus provides the following components in CompLibrary:

+

CompLibrary.Marked #

+

A React component that parses Markdown to html.

+

Example:

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

CompLibrary.Container #

A React container component using Docusaurus styles. Has optional padding and background color attributes that you can configure.

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

Example:

<Container padding={["bottom", "top"]} background="light">
-  ...         
-</Container>

CompLibrary.GridBlock #

A React component to organize text and images.

The align attribute determines text alignment. Text alignment defaults to left and can be set to center or right.

The layout attribute determines number of column sections per GridBlock. layout defaults to twoColumn and can be set to threeColumn or fourColumn as well.

The contents attribute is an array containing the contents of each section of the GridBlock. Each content object can have the following fields:

  • content for the text of this section, which is parsed from markdown
  • image for the path to an image to display
  • imageAlign field for image alignment relative to the text, which defaults to top and can be set to bottom, left, or right
  • title for the title to display for this section, which is parsed from markdown
  • imageLink for a link destination from clicking the image

Example:

<GridBlock
-  align="center"
-  contents={[
-    {
-      content: "Learn how to use this project",
-      image: siteConfig.baseUrl + "img/learn.png",
-      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
-      imageLink: siteConfig.baseUrl + "docs/tutorial.html"
-    },
-    {
-      content: "Questions gathered from the community",
-      image: siteConfig.baseUrl + "img/faq.png",
-      imageAlign: "top",
-      title: "Frequently Asked Questions"
-    },
-    {
-      content: "Lots of documentation is on this site",
-      title: "More"
-    }
-  ]}
-  layout="threeColumn"
-/>

More examples of how these components are used can be found in the generated example files as well as in Docusaurus's own repo for its website set-up.

Translating 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>

You can also provide an optional description attribute to provide context for translators. e.g,

<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;

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 #

Static assets should be placed into the website/static folder. They can be accesssed by their paths, excluding "static". For example, if the site's baseUrl is "/docusaurus/", an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

Styles #

You should configure your site's primary, secondary, and Prism colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus's provided styles, allowing you to add to or override Docusaurus default styles as you wish.

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

Adding Static Pages #

Static .html files can also be used, but they will not include Docusaurus's header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. Alternatively, they can be placed in the pages folder and would be served as-is instead of being rendered from React.

If you wish to use Docusaurus's stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus's styles by adding them into the siteConfig.separateCss field.

← PreviousNext →
Docusaurus
Docs
<Marked>[Markdown syntax for a link](http://www.example.com)</Marked> + +

CompLibrary.Container #

+

A React container component using Docusaurus styles. Has optional padding and background color attributes that you can configure.

+

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

+

Example:

+
<Container padding={["bottom", "top"]} background="light">
+  ...         
+</Container>
+
+

CompLibrary.GridBlock #

+

A React component to organize text and images.

+

The align attribute determines text alignment. Text alignment defaults to left and can be set to center or right.

+

The layout attribute determines number of column sections per GridBlock. layout defaults to twoColumn and can be set to threeColumn or fourColumn as well.

+

The contents attribute is an array containing the contents of each section of the GridBlock. Each content object can have the following fields:

+
    +
  • content for the text of this section, which is parsed from markdown
    • +
  • image for the path to an image to display
    • +
  • imageAlign field for image alignment relative to the text, which defaults to top and can be set to bottom, left, or right
    • +
  • title for the title to display for this section, which is parsed from markdown
    • +
  • imageLink for a link destination from clicking the image
    • +
+

Example:

+
<GridBlock
+  align="center"
+  contents={[
+    {
+      content: "Learn how to use this project",
+      image: siteConfig.baseUrl + "img/learn.png",
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      imageLink: siteConfig.baseUrl + "docs/tutorial.html"
+    },
+    {
+      content: "Questions gathered from the community",
+      image: siteConfig.baseUrl + "img/faq.png",
+      imageAlign: "top",
+      title: "Frequently Asked Questions"
+    },
+    {
+      content: "Lots of documentation is on this site",
+      title: "More"
+    }
+  ]}
+  layout="threeColumn"
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus's own repo for its website set-up.

+

Translating 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>
+
+

You can also provide an optional description attribute to provide context for translators. e.g,

+
<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;
+
+

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 #

+

Static assets should be placed into the website/static folder. They can be accesssed by their paths, excluding "static". For example, if the site's baseUrl is "/docusaurus/", an image in website/static/img/logo.png is available at /docusaurus/img/logo.png.

+

Styles #

+

You should configure your site's primary, secondary, and code block colors using the colors field in siteConfig as specified here. You can also configure other colors in the same way as described in the siteConfig doc.

+

You can provide your own custom styles by adding them anywhere in the website/static folder. Any .css files you provide in the static folder will get concatenated to the end of Docusaurus's provided styles, allowing you to add to or override Docusaurus default styles as you wish.

+

An easy way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

+

Adding Static Pages #

+

Static .html files can also be used, but they will not include Docusaurus's header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. Alternatively, they can be placed in the pages folder and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus's stylesheet, you can access it at ${baseUrl}css/main.css. If you wish to use separate css for these static pages, you can exclude them from being concatenated to Docusaurus's styles by adding them into the siteConfig.separateCss field.

+
← PreviousNext →
\ 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 8d8b4ece51..ef0acc0a7a 100644 --- a/docs/en/blog.html +++ b/docs/en/blog.html @@ -1,39 +1,64 @@ -Adding a Blog · Docusaurus

Docusaurus

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: [
+    ...
+    {blog: true, label: 'Blog'},
+    ...
+]
+
+

Adding Posts #

+

To publish in the blog, create a file within the blog folder with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

For example, at website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
 
-Lorem Ipusm..

Header Options #

The only required field is title; however, we provide options to add author information to your blog post as well.

  • author - The text label of the author byline.
  • authorURL - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
  • authorFBID - The Facebook ID that is used to extract the profile picture.
  • title - The blog post title.

Summary Truncation #

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above <!--truncate--> will be part of the summary. For example:

---
-title: Truncation Exmaple
----
+Lorem Ipusm..
+
+

Header Options #

+

The only required field is title; however, we provide options to add author information to your blog post as well.

+
    +
  • author - The text label of the author byline.
    • +
  • authorURL - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook ID that is used to extract the profile picture.
    • +
  • title - The blog post title.
    • +
+

Summary Truncation #

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above <!--truncate--> will be part of the summary. For example:

+
---
+title: Truncation Exmaple
+---
 
-All this will be part of the blog post summary.
+All this will be part of the blog post summary.
 
-Even this.
+Even this.
 
-<!--truncate-->
+<!--truncate-->
 
-But anything from here on down will not be.
+But anything from here on down will not be.
 
-Not this.
+Not this.
 
-Or this.

RSS Feed #

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML <HEAD> tag.

A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 chacters are used.

← PreviousNext →
Docusaurus
Docs
Or this. + +

RSS Feed #

+

Docusaurus provides a simple RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically to your website page's HTML <HEAD> tag.

+

A summary of the post's text is provided in the RSS feed up to the <!--truncate-->. If no <!--truncate--> tag is found, then all text up 250 chacters are used.

+
← PreviousNext →
\ 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 7cfc64595d..7c90576d14 100644 --- a/docs/en/commands.html +++ b/docs/en/commands.html @@ -1,14 +1,87 @@ -CLI Commands · Docusaurus

Docusaurus

\ 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 188c95e78e..806be250fc 100644 --- a/docs/en/custom-pages.html +++ b/docs/en/custom-pages.html @@ -1,22 +1,34 @@ -Custom Pages · Docusaurus

Docusaurus

Edit

Custom Pages

Customizing Your Home Page #

+

The easiest way to get started customizing your home page is to use the examples generated previously. 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 Pages #

+

Docusaurus provides some simple example pages (index.js, users.js, help.js), but of course you're also free to write your own pages however you want. It is strongly suggested that you at least have an index page, but none of the pages are mandatory to include. More information on how to use the provided components or include your own can be found here. Information on how to link to your different pages in the header navigation bar can be found here.

+

Customizing Your Site Footer #

+

Starting from the example core/Footer.js file you generated before, edit the footer to include any links to pages on your site or elsewhere that you wish to have.

+

The example provided has three columns with a footer image on the left and Facebook's open source logo and copyright at the bottom. If your project is not a Facebook open source project, remove the logo and copyright. Otherwise, feel free to get creative with your footer and make it look however you'd like!

+

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");
 
-class Footer extends React.Component {
-  render() {
-    return null;
-  }
-}
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
 
-module.exports = Footer;
← PreviousNext →
← PreviousNext →
\ 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 10954adfee..d717dd4b4b 100644 --- a/docs/en/doc-markdown.html +++ b/docs/en/doc-markdown.html @@ -1,36 +1,114 @@ -Markdown Features · Docusaurus

Docusaurus

Edit

Markdown Features

Markdown Headers #

+

Documents #

+

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

+

id: A unique document id. If this field is not present, the document's id will default to it's file name (without the extension).

+

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

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

Blog Posts #

+

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

+

title: The title of this blog post.

+

author: The author of this blog post. If this field is omitted, no author name will be shown.

+

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

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 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)
+
+

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)`
 
 Text describing my function
 
 
-### `docdoc(file)`
+### `docdoc(file)`
 
-Text describing my function

will lead to a table of contents of the functions:

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

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

← Previous
Docusaurus
Docs
- `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
+ReactDOM.render(
+  <h1>Hello, world!</h1>,
+  document.getElementById('root')
+);
+```
+
+

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

+
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'
+}
+
+

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) {
+      // ...
+    });
+  }
+}
+
+
← Previous
\ 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 b0b6fd8ae8..87b7c8fc7c 100644 --- a/docs/en/installation.html +++ b/docs/en/installation.html @@ -1,21 +1,35 @@ -Installation · Docusaurus

Docusaurus

\ 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 06bf94ae61..31e6959dc8 100644 --- a/docs/en/navigation.html +++ b/docs/en/navigation.html @@ -1,54 +1,94 @@ -Navigation and Sidebars · Docusaurus

Docusaurus

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
+---
 
-My *new content* here..

Now, the doc can be accessed from /docs/intro.html.

Adding Docs to a Sidebar #

Now we want our new page to show up on the sidebar. We configure the order of the sidebar in website/sidebars.json.

Within sidebars.json, add the doc ID within an existing sidebar/category:

{
-  "docs": {
-    "Getting Started": [
-      "getting-started"

Or you can create a new category within the sidebar:

{
-  "docs": {
-    ...
-    "My New Sidebar Category": [
-      "getting-started"
-    ],
-    ...

New Hidden Sections #

You can also put the doc in a new sidebar. In this case we are creating a intro section within sidebars.json.

{
-  "intro": {
-    "My Sidebar Category": [
-      "getting-started"
-    ],
-  },
-  ...

Keep in mind, until you add the section to the nav bar (below), this new "intro" section of the site will be hidden with no links going to it.

Adding doc to site nav bar #

After creating a new section of the site by adding to sidebars.json, you can link to the new doc from the top navigation bar by editing the headerLinks field of siteConfig.js.

headerLinks: [
-  ...
-  { doc: 'intro', label: 'Getting Started' },
-  ...
-],

Custom page links in nav bar #

To add custom pages to the navigation bar, entries can be added to the headerLinks of siteConfig.js. For example, if we have a page within website/pages/help.js, we can link to it by adding the following:

headerLinks: [
-  ...
-  { page: 'help', label: 'Help' },
-  ...
-],

External links in nav bar #

Custom links can be added to the nav bar with the following entry in siteConfig.js:

headerLinks: [
-  ...
-  { href: 'https://github.com/facebookexperimental/Docusaurus', label: 'GitHub' },
-  ...
-],

To open external links in a new tab, provide an external: true flag within the header link config.

Search bar position in nav bar #

If search is enabled on your site, your search bar will appear to the right of your links. If you want to put the search bar between links in the header, add a search entry in the headerLinks config array:

headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { search: true },
-  { doc: 'bar', label: 'Bar' },
-],

Languages dropdown position in nav bar #

If translations is enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). If you want to put the language selection drop down between links in the header, add a languages entry in the headerLinks config array:

headerLinks: [
-  { doc: 'foo', label: 'Foo' },
-  { languages: true },
-  { doc: 'bar', label: 'Bar' },
-],
← PreviousNext →
Docusaurus
Docs
My *new content* here.. + +

Now, the doc can be accessed from /docs/intro.html.

+

Adding Docs to a Sidebar #

+

Now we want our new page to show up on the sidebar. We configure the order of the sidebar in website/sidebars.json.

+

Within sidebars.json, add the doc ID within an existing sidebar/category:

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+
+

Or you can create a new category within the sidebar:

+
{
+  "docs": {
+    ...
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+
+

New Hidden Sections #

+

You can also put the doc in a new sidebar. In this case we are creating a intro section within sidebars.json.

+
{
+  "intro": {
+    "My Sidebar Category": [
+      "getting-started"
+    ],
+  },
+  ...
+
+

Keep in mind, until you add the section to the nav bar (below), this new "intro" section of the site will be hidden with no links going to it.

+

Adding doc to site nav bar #

+

After creating a new section of the site by adding to sidebars.json, you can link to the new doc from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
headerLinks: [
+  ...
+  { doc: 'intro', label: 'Getting Started' },
+  ...
+],
+
+

Custom page links in nav bar #

+

To add custom pages to the navigation bar, entries can be added to the headerLinks of siteConfig.js. For example, if we have a page within website/pages/help.js, we can link to it by adding the following:

+
headerLinks: [
+  ...
+  { page: 'help', label: 'Help' },
+  ...
+],
+
+

External links in nav bar #

+

Custom links can be added to the nav bar with the following entry in siteConfig.js:

+
headerLinks: [
+  ...
+  { href: 'https://github.com/facebookexperimental/Docusaurus', label: 'GitHub' },
+  ...
+],
+
+

To open external links in a new tab, provide an external: true flag within the header link config.

+

Search bar position in nav bar #

+

If search is enabled on your site, your search bar will appear to the right of your links. If you want to put the search bar between links in the header, add a search entry in the headerLinks config array:

+
headerLinks: [
+  { doc: 'foo', label: 'Foo' },
+  { search: true },
+  { doc: 'bar', label: 'Bar' },
+],
+
+

Languages dropdown position in nav bar #

+

If translations is enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). If you want to put the language selection drop down between links in the header, add a languages entry in the headerLinks config array:

+
headerLinks: [
+  { doc: 'foo', label: 'Foo' },
+  { languages: true },
+  { doc: 'bar', label: 'Bar' },
+],
+
+
← PreviousNext →
\ 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 aad6e4c351..ff321d9c48 100644 --- a/docs/en/publishing.html +++ b/docs/en/publishing.html @@ -1,25 +1,69 @@ -Publishing your site · Docusaurus

Docusaurus

\ 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 8d76ce6459..e6607de7ff 100644 --- a/docs/en/search.html +++ b/docs/en/search.html @@ -1,40 +1,57 @@ -Enabling Search · Docusaurus

Docusaurus

\ 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 1ac2798d9d..c502377fb4 100644 --- a/docs/en/site-config.html +++ b/docs/en/site-config.html @@ -1,79 +1,136 @@ -siteConfig.js · Docusaurus

Docusaurus

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

+

siteConfig Fields #

+

The siteConfig object contains the bulk of the configuration settings for your website.

+

Mandatory Fields #

+

title - Title for your website.

+

tagline - Tagline for your website.

+

url - url for your site.

+

baseUrl - baseUrl for your site.

+

projectName - Project name. This must match your GitHub repo project name (case sensitive).

+

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: [
+  // 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
+  { page: "help", label: "Help" },
+  // Links to href destination
+  { href: "https://github.com/", label: "GitHub" },
+  // Links to blog generated by Docusaurus (${baseUrl}blog)
+  { blog: true, label: "Blog" },
+  // Determines search bar position among links
+  { search: true },
+  // Determines language drop down position among links
+  { languages: true }
+],
+
+

headerIcon - url for icon used in header navigation bar.

+

favicon - url for site favicon.

+

colors - Color configurations for the site.

+
    +
  • primaryColor is the color used the header navigation bar and sidebars.
    • +
  • secondaryColor is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile).
    • +
  • Custom color configurations can also be added. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to easily configure this color.
    • +
+

copyright - The copyright string at footer of site and within feed

+

Optional Fields #

+

editUrl - url for editing docs, usage example: editUrl + 'en/doc1.md'. If this field is omitted, there will be no "Edit this Doc" button for each document.

+

users - The users array mentioned earlier.

+

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.

+

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus's styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

footerIcon - url for a footer icon. Currently used in the core/Footer.js file provided as an example, but it can be removed from that file.

+

translationRecruitingLink - url for the Help Translate tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be.

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

sourceCodeButton - the type of button to use for pointing to your source code. If this field is non-null, the site will pull in the appropriate button code in the header, for you to be able to render as you see fit. Currently accepted values: "github", "none". Defaults to "github".

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code.
    • +
  • version specifies a particular version of Highlight.js to be used.
    • +
  • hljs provides an escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
    • +
+

markdownPlugins - An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined.

+

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 = [
+  {
+    caption: "User1",
+    image: "/test-site/img/docusaurus.svg",
+    infoLink: "https://www.example.com",
+    pinned: true
+  }
+];
 
-const siteConfig = {
-  title: "Docusaurus",
-  tagline: "Generate websites!",
-  url: "https://deltice.github.io",
-// url: "https://www.example.com",
-  baseUrl: "/test-site/",
-// baseUrl: "/",
-  projectName: "docusaurus",
-  noIndex: false,
-  headerLinks: [
-    { doc: "doc1", label: "Docs" },
-    { page: "help", label: "Help" },
-    { search: true },
-    { blog: true }
-  ],
-// headerLinks: [],
-  headerIcon: "img/docusaurus.svg",
-  favicon: "img/favicon.png",
-  colors: {
-    primaryColor: "#2E8555",
-    secondaryColor: "#205C3B",
-    prismColor:
-      "rgba(46, 133, 85, 0.03)"
-  },
+const siteConfig = {
+  title: "Docusaurus",
+  tagline: "Generate websites!",
+  url: "https://deltice.github.io",
+// url: "https://www.example.com",
+  baseUrl: "/test-site/",
+// baseUrl: "/",
+  projectName: "docusaurus",
+  noIndex: false,
+  headerLinks: [
+    { doc: "doc1", label: "Docs" },
+    { page: "help", label: "Help" },
+    { search: true },
+    { blog: true }
+  ],
+// headerLinks: [],
+  headerIcon: "img/docusaurus.svg",
+  favicon: "img/favicon.png",
+  colors: {
+    primaryColor: "#2E8555",
+    secondaryColor: "#205C3B"
+  },
+  editUrl: "https://github.com/deltice/test-site/edit/master/docs/",
+  users,
+  disableHeaderTitle: true,
+  disableTitleTagline: true,
+  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
+  footerIcon: "img/docusaurus.svg",
+  translationRecruitingLink:
+    "https://crowdin.com/project/docusaurus",
+  algolia: {
+    apiKey:
+      "0f9f28b9ab9efae89810921a351753b5",
+    indexName: "github"
+  },
+  gaTrackingId: "U-A2352",
+  sourceCodeButton: "github",
+  highlight: {
+    theme: 'default'
+  },
+  markdownPlugins: [
+    function foo(md) {
+      md.renderer.rules.fence_custom.foo = function(tokens, idx, options, env, instance) {
+        return '<div class="foo">bar</div>';
+      }
+    }
+  ],
+  scripts: [ "https://docusaurus.io/slash.js" ]
 
+};
 
-  editUrl: "https://github.com/deltice/test-site/edit/master/docs/",
-  users,
-  disableHeaderTitle: true,
-  disableTitleTagline: true,
-  separateCss: ["static/css/non-docusaurus", "static/assets/separate-css"],
-  footerIcon: "img/docusaurus.svg",
-  translationRecruitingLink:
-    "https://crowdin.com/project/docusaurus",
-  algolia: {
-    apiKey:
-      "0f9f28b9ab9efae89810921a351753b5",
-    indexName: "github"
-  },
-  gaTrackingId: "U-A2352",
-  sourceCodeButton: "github"
-};
-
-module.exports = siteConfig;
← PreviousNext →
← PreviousNext →
\ 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 d6d3e802c0..4245b41089 100644 --- a/docs/en/site-creation.html +++ b/docs/en/site-creation.html @@ -1,21 +1,50 @@ -Creating your site · Docusaurus

Docusaurus

\ 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 fad89dd10d..b4fb917720 100644 --- a/docs/en/site-preparation.html +++ b/docs/en/site-preparation.html @@ -1,19 +1,62 @@ -Site Preparation · Docusaurus

Docusaurus

\ 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 6053f361bf..27b51491ba 100644 --- a/docs/en/translation.html +++ b/docs/en/translation.html @@ -1,81 +1,162 @@ -Translations & Localization · Docusaurus

Docusaurus

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

or

+
yarn examples translations
+
+

This will create the following files:

+
pages/en/help-with-translations.js
+languages.js
+crowdin.yaml
+
+

The pages/en/help-with-translations.js file includes the same starter help page generated by the examples script, but now includes translation tags.

+

The languages.js file tells Docusaurus what languages you want to enable for your site. By default, we expect English to be enabled.

+

The crowdin.yaml file is used to configure crowdin integration, and is copied up one level into your docusaurus project repo. If your docusaurus project resides in /project/website, then crowdin.yaml will be copied to /project/crowdin.yaml.

+

Translating Your Existing Docs #

+

Your documentation files do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Enabling Translations on Pages #

+

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>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

You can also include an optional description attribute to give more context to a translator about how to translate the string:

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

Running the script will generate a website/i18n/en.json file containing all the strings that will be translated from English into other languages.

+

The script will include text from the following places:

+
    +
  • title and sidebar_label strings in document markdown headers
    • +
  • category names in sidebars.json
    • +
  • tagline in siteConfig.js
    • +
  • header link label strings in siteConfig.js
    • +
  • strings wrapped in the <translate> tag in any .js files inside pages
    • +
+

How Strings Get Translated #

+

Docusaurus itself does not do any translation from one language to another. Instead, it integrates Crowdin to upload translations and then downloads the appropriately translated files from Crowdin.

+

How Docusaurus Uses String Translations #

+

This section provides context about how translations in Docusaurus works.

+

Strings #

+

A Docusaurus site has many strings used throughout it that require localization. However, maintaining a list of strings used through out a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example can have links to 'Home' or your 'Blog'. This and other strings found in the headers and sidebars of pages are extracted and placed into i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Then, when the Spanish pages are generated, Docusaurus will replace the English version of corresponding strings with translated strings from the corresponding localized strings file (e.g. In a Spanish enabled site 'Help' will become 'Ayuda').

+

Markdown Files #

+

For documentation files themselves, translated versions of these files are downloaded and then rendered through the proper layout template.

+

Other Pages #

+

For other pages, Docusaurus will automatically transform all <translate> tags it finds into function calls that return the translated strings from the corresponding localized file locale.json.

+

Crowdin #

+

Crowdin is a company that provides translation services. For Open Source projects, Crowdin provides free string translations

+

Create your translation project on Crowdin. You can use Crowdin's guides to learn more about the translations work flow.

+

Your project will need a crowdin.yaml file generated.

+

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
+api_key_env: CROWDIN_DOCUSAURUS_API_KEY
+base_path: "./"
+preserve_hierarchy: true
 
-files:
-  -
-    source: '/docs/*.md'
-    translation: '/website/translated_docs/%locale%/%original_file_name%'
-    languages_mapping: &anchor
-      locale:
-        'de': 'de'
-        'es-ES': 'es-ES'
-        'fr': 'fr'
-        'ja': 'ja'
-        'ko': 'ko'
-        'mr': 'mr-IN'
-        'pt-BR': 'pt-BR'
-        'zh-CN': 'zh-Hans'
-        'zh-TW': 'zh-Hant'

You can go here to learn more about customizing your crowdin.yaml file.

Manual File Sync #

You can add the following to your package.json to manually trigger crowdin. 

"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; export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml download -b master"
-},

These commands require having an environment variable set with your crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can add them inline like above or add them permanently to your .bashrc or .bash_profile.

If you run more than one localized Docusaurus project on your computer, you should change the name of the enviroment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

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:
-  node:
-    version: 6.10.3
-  npm:
-    version: 3.10.10
+files:
+  -
+    source: '/docs/*.md'
+    translation: '/website/translated_docs/%locale%/%original_file_name%'
+    languages_mapping: &anchor
+      locale:
+        'de': 'de'
+        'es-ES': 'es-ES'
+        'fr': 'fr'
+        'ja': 'ja'
+        'ko': 'ko'
+        'mr': 'mr-IN'
+        'pt-BR': 'pt-BR'
+        'zh-CN': 'zh-Hans'
+        'zh-TW': 'zh-Hant'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Manual File Sync #

+

You can add the following to your package.json to manually trigger crowdin.

+
"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; export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml download -b master"
+},
+
+

These commands require having an environment variable set with your crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can add them inline like above or add them permanently to your .bashrc or .bash_profile.

+

If you run more than one localized Docusaurus project on your computer, you should change the name of the enviroment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

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:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
 
-test:
-  override:
-    - "true"
+test:
+  override:
+    - "true"
 
-deployment:
-  website:
-    branch: master
-    commands:
-      # configure git user
-      - git config --global user.email "test-site-bot@users.noreply.github.com"
-      - git config --global user.name "Website Deployment Script"
-      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
-      # install Docusaurus and generate file of English strings
-      - cd website && npm install && npm run write-translations && cd ..
-      # crowdin install
-      - sudo apt-get install default-jre
-      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
-      - sudo dpkg -i crowdin.deb
-      # translations upload/download
-      - crowdin --config crowdin.yaml upload sources --auto-update -b master
-      - crowdin --config crowdin.yaml download -b master
-      # build and publish website
-      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages

The crowdin command uses the crowdin.yaml file generated with the examples script. It should be placed in your project directory to configure how and what files are uploaded/downloaded.

Note that in the crowdin.yaml file, CROWDIN_PROJECT_ID and CROWDIN_API_KEY are environment variables set-up in Circle for your Crowdin project. They can be found in your Crowdin project settings.

Now, Circle will help you automatically get translations prior to building your website. The provided crowdin.yaml file will copy translated documents into website/translated_docs/, and translated versions of the i18n/en.json strings file will into i18n/${language}.json.

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

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

Translated, versioned documents will be copied into website/translated_docs/${language}/${version}/.

← PreviousNext →
← PreviousNext →
\ 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 8a6b635f01..68f2bf008f 100644 --- a/docs/en/versioning.html +++ b/docs/en/versioning.html @@ -1,22 +1,54 @@ -Versioning · Docusaurus

Docusaurus

\ No newline at end of file + \ No newline at end of file diff --git a/docs/installation.html b/docs/installation.html index a17b6383ef..5667ab2e6a 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -1,4 +1,4 @@ -Docusaurus · Easy to Maintain Open Source Documentation Websites

Docusaurus

Need help?

This project is maintained by a dedicated group of people.

Browse Docs

Learn more using the documentation on this site.

Join the community

Submit issues and pull requests for any new features you may want to see or bugs you've found on GitHub.

Stay up to date

Find out what's new with this project by checking back on the site.