diff --git a/docs/en/1.7.3/doc-markdown.html b/docs/en/1.7.3/doc-markdown.html index 1099979583..69e10fb704 100644 --- a/docs/en/1.7.3/doc-markdown.html +++ b/docs/en/1.7.3/doc-markdown.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/en/1.7.3/doc-markdown/index.html b/docs/en/1.7.3/doc-markdown/index.html index 1099979583..69e10fb704 100644 --- a/docs/en/1.7.3/doc-markdown/index.html +++ b/docs/en/1.7.3/doc-markdown/index.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/en/doc-markdown.html b/docs/en/doc-markdown.html index 7aed393d11..e6c39acba5 100644 --- a/docs/en/doc-markdown.html +++ b/docs/en/doc-markdown.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/en/doc-markdown/index.html b/docs/en/doc-markdown/index.html index 7aed393d11..e6c39acba5 100644 --- a/docs/en/doc-markdown/index.html +++ b/docs/en/doc-markdown/index.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/es-ES/1.7.3/doc-markdown.html b/docs/es-ES/1.7.3/doc-markdown.html index c96e107d03..6c310dc364 100644 --- a/docs/es-ES/1.7.3/doc-markdown.html +++ b/docs/es-ES/1.7.3/doc-markdown.html @@ -152,10 +152,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/es-ES/1.7.3/doc-markdown/index.html b/docs/es-ES/1.7.3/doc-markdown/index.html index c96e107d03..6c310dc364 100644 --- a/docs/es-ES/1.7.3/doc-markdown/index.html +++ b/docs/es-ES/1.7.3/doc-markdown/index.html @@ -152,10 +152,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/es-ES/doc-markdown.html b/docs/es-ES/doc-markdown.html index 1cc36a922a..65e3840d12 100644 --- a/docs/es-ES/doc-markdown.html +++ b/docs/es-ES/doc-markdown.html @@ -152,10 +152,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/es-ES/doc-markdown/index.html b/docs/es-ES/doc-markdown/index.html index 1cc36a922a..65e3840d12 100644 --- a/docs/es-ES/doc-markdown/index.html +++ b/docs/es-ES/doc-markdown/index.html @@ -152,10 +152,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/ro/1.7.3/doc-markdown.html b/docs/ro/1.7.3/doc-markdown.html index 39c8d85749..bd415e0e3c 100644 --- a/docs/ro/1.7.3/doc-markdown.html +++ b/docs/ro/1.7.3/doc-markdown.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/ro/1.7.3/doc-markdown/index.html b/docs/ro/1.7.3/doc-markdown/index.html index 39c8d85749..bd415e0e3c 100644 --- a/docs/ro/1.7.3/doc-markdown/index.html +++ b/docs/ro/1.7.3/doc-markdown/index.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/ro/doc-markdown.html b/docs/ro/doc-markdown.html index 5aa2e5d114..cc346dbe17 100644 --- a/docs/ro/doc-markdown.html +++ b/docs/ro/doc-markdown.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/ro/doc-markdown/index.html b/docs/ro/doc-markdown/index.html index 5aa2e5d114..cc346dbe17 100644 --- a/docs/ro/doc-markdown/index.html +++ b/docs/ro/doc-markdown/index.html @@ -158,10 +158,10 @@ Text describing my function

Adding the following code to your Markdown file:

produces this:

-
console.log('Hello, world!');
-
print('Hello, world!')
-
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
-
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.

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

diff --git a/docs/tr/1.0.x/api-pages.html b/docs/tr/1.0.x/api-pages.html new file mode 100644 index 0000000000..43c791e150 --- /dev/null +++ b/docs/tr/1.0.x/api-pages.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.0.x

Translate

Pages and Styles

Docusaurus sayfaları React bileşenleri olarak sitenin geri kalanı ile aynı başlık, altbilgi ve stilleri paylaşan website/sayfalar klasörü içine yazmanıza olanak sağlar.

+

URLs for Pages

+

website/sayfalar içerisindeki herhangi bir .js dosyası "sayfalar" dosyasından sonraki yolu kullanarak statik html'e çevrilir. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. Örnek olarak, website/sayfalar/ing/yardım.js sayfası için dosya ${baseUrl}ing/yardım.js url'sinde bulunacaktır aynı zamanda ${baseUrl} içerisindeki ${baseUrl}yardım.js url'si siteConfig.js dosyası içerisinde ayarlı bazUrl alanıdır.

+

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

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.0.x/api-pages/index.html b/docs/tr/1.0.x/api-pages/index.html new file mode 100644 index 0000000000..43c791e150 --- /dev/null +++ b/docs/tr/1.0.x/api-pages/index.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.0.x

Translate

Pages and Styles

Docusaurus sayfaları React bileşenleri olarak sitenin geri kalanı ile aynı başlık, altbilgi ve stilleri paylaşan website/sayfalar klasörü içine yazmanıza olanak sağlar.

+

URLs for Pages

+

website/sayfalar içerisindeki herhangi bir .js dosyası "sayfalar" dosyasından sonraki yolu kullanarak statik html'e çevrilir. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. Örnek olarak, website/sayfalar/ing/yardım.js sayfası için dosya ${baseUrl}ing/yardım.js url'sinde bulunacaktır aynı zamanda ${baseUrl} içerisindeki ${baseUrl}yardım.js url'si siteConfig.js dosyası içerisinde ayarlı bazUrl alanıdır.

+

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

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.0.x/blog.html b/docs/tr/1.0.x/blog.html new file mode 100644 index 0000000000..7879ea117d --- /dev/null +++ b/docs/tr/1.0.x/blog.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.0.x

Translate

Adding a Blog

İlk Kurulum

+

Sitenizin blog'unu kurmak için, deponuzun website dizinine blog klasörünü oluşturmakla başlayın.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Yayınlanan tüm blog paylaşımları incelenirken bu paylaşımınızın özet olarak neresinin gösterileceğini belirtmek için <!--truncate--> işaretleyicisini kullanın. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL'
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.0.x/blog/index.html b/docs/tr/1.0.x/blog/index.html new file mode 100644 index 0000000000..7879ea117d --- /dev/null +++ b/docs/tr/1.0.x/blog/index.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.0.x

Translate

Adding a Blog

İlk Kurulum

+

Sitenizin blog'unu kurmak için, deponuzun website dizinine blog klasörünü oluşturmakla başlayın.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Yayınlanan tüm blog paylaşımları incelenirken bu paylaşımınızın özet olarak neresinin gösterileceğini belirtmek için <!--truncate--> işaretleyicisini kullanın. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL'
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.0.x/commands.html b/docs/tr/1.0.x/commands.html new file mode 100644 index 0000000000..63b0779c40 --- /dev/null +++ b/docs/tr/1.0.x/commands.html @@ -0,0 +1,187 @@ +CLI Commands · Docusaurus

1.0.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples [feature]

+

Eşdeğeri: -c

+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +

  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.

    • +

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

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version <currentVersion> <newVersion>

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+

See the Versioning guide to learn more.

+
+

docusaurus-start [--port <number>]

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.0.x/commands/index.html b/docs/tr/1.0.x/commands/index.html new file mode 100644 index 0000000000..63b0779c40 --- /dev/null +++ b/docs/tr/1.0.x/commands/index.html @@ -0,0 +1,187 @@ +CLI Commands · Docusaurus

1.0.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples [feature]

+

Eşdeğeri: -c

+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide. Specify a feature translations or versions to generate the extra example files for that feature.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +

  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.

    • +

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

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version <currentVersion> <newVersion>

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+

See the Versioning guide to learn more.

+
+

docusaurus-start [--port <number>]

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.0.x/custom-pages.html b/docs/tr/1.0.x/custom-pages.html new file mode 100644 index 0000000000..70e4b32efe --- /dev/null +++ b/docs/tr/1.0.x/custom-pages.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.0.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. Alternatif olarak, pages klasörüne de eklenebilirler ve React tarafından işlenmek yerine oldukları gibi kullanılmalıdırlar.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← ÖncekiEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.0.x/custom-pages/index.html b/docs/tr/1.0.x/custom-pages/index.html new file mode 100644 index 0000000000..70e4b32efe --- /dev/null +++ b/docs/tr/1.0.x/custom-pages/index.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.0.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. Alternatif olarak, pages klasörüne de eklenebilirler ve React tarafından işlenmek yerine oldukları gibi kullanılmalıdırlar.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← ÖncekiEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.0.x/doc-markdown.html b/docs/tr/1.0.x/doc-markdown.html new file mode 100644 index 0000000000..acc07fe252 --- /dev/null +++ b/docs/tr/1.0.x/doc-markdown.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.0.x

Translate

Markdown Features

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

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.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog Postları her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

Diğer dokümantasyon dosyaları için bunlar, işlenerek otomatik olarak karşılık gelen html bağlantılarına dönüştürülen diğer dokümantasyon dosyaları ile ilişkili bağlantılar kullanabilirsiniz.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

Bu bağlantılar diğer dokümanlar (hala GitHub içerisinde) için çalışan bağlantılar olacağından GitHub dosyaları arasında dolaşmak istediğinizde işe yarayacaktır ama ama dokümanlar işlendiklerinde doğru html bağlantılarına sahip olacaklar.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Statik varlıklar dokümanlarla gibi ilişkili url'leri kullanarak bağlantılanabilirler. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

API belgeleri için içeriklerin bir tablosu olarak kullanışlı olabilen otomatik oluşturulan linklerin bir listesini yapabilirsiniz.

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.0.x/doc-markdown/index.html b/docs/tr/1.0.x/doc-markdown/index.html new file mode 100644 index 0000000000..acc07fe252 --- /dev/null +++ b/docs/tr/1.0.x/doc-markdown/index.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.0.x

Translate

Markdown Features

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

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.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog Postları her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

Diğer dokümantasyon dosyaları için bunlar, işlenerek otomatik olarak karşılık gelen html bağlantılarına dönüştürülen diğer dokümantasyon dosyaları ile ilişkili bağlantılar kullanabilirsiniz.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

Bu bağlantılar diğer dokümanlar (hala GitHub içerisinde) için çalışan bağlantılar olacağından GitHub dosyaları arasında dolaşmak istediğinizde işe yarayacaktır ama ama dokümanlar işlendiklerinde doğru html bağlantılarına sahip olacaklar.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Statik varlıklar dokümanlarla gibi ilişkili url'leri kullanarak bağlantılanabilirler. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

API belgeleri için içeriklerin bir tablosu olarak kullanışlı olabilen otomatik oluşturulan linklerin bir listesini yapabilirsiniz.

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.0.x/installation.html b/docs/tr/1.0.x/installation.html new file mode 100644 index 0000000000..b56b8f2c3d --- /dev/null +++ b/docs/tr/1.0.x/installation.html @@ -0,0 +1,147 @@ +Installation · Docusaurus

1.0.x

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    While we recommend Node 8.x or greater, your Node version must at least 6.x.

    +
    2. +

  2. Go into the root of your GitHub repo directory where you will be creating the docs.

    3. +

  3. npx docusaurus-init

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-of-repo
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. In your root, rename docs-examples-from-docusaurus to docs.
    2. +
  2. cd website
    3. +
  3. Rename blog-examples-from-docusaurus to blog.
    4. +
  4. Run the local webserver via yarn start or npm start.
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.0.x/installation/index.html b/docs/tr/1.0.x/installation/index.html new file mode 100644 index 0000000000..b56b8f2c3d --- /dev/null +++ b/docs/tr/1.0.x/installation/index.html @@ -0,0 +1,147 @@ +Installation · Docusaurus

1.0.x

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    While we recommend Node 8.x or greater, your Node version must at least 6.x.

    +
    2. +

  2. Go into the root of your GitHub repo directory where you will be creating the docs.

    3. +

  3. npx docusaurus-init

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-of-repo
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. In your root, rename docs-examples-from-docusaurus to docs.
    2. +
  2. cd website
    3. +
  3. Rename blog-examples-from-docusaurus to blog.
    4. +
  4. Run the local webserver via yarn start or npm start.
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.0.x/navigation.html b/docs/tr/1.0.x/navigation.html new file mode 100644 index 0000000000..9ed67de1ef --- /dev/null +++ b/docs/tr/1.0.x/navigation.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.0.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.0.x/navigation/index.html b/docs/tr/1.0.x/navigation/index.html new file mode 100644 index 0000000000..9ed67de1ef --- /dev/null +++ b/docs/tr/1.0.x/navigation/index.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.0.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.0.x/publishing.html b/docs/tr/1.0.x/publishing.html new file mode 100644 index 0000000000..7fef482bb8 --- /dev/null +++ b/docs/tr/1.0.x/publishing.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.0.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only one circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:7.10
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← Creating your siteSonraki →
\ No newline at end of file diff --git a/docs/tr/1.0.x/publishing/index.html b/docs/tr/1.0.x/publishing/index.html new file mode 100644 index 0000000000..7fef482bb8 --- /dev/null +++ b/docs/tr/1.0.x/publishing/index.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.0.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only one circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:7.10
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← Creating your siteSonraki →
\ No newline at end of file diff --git a/docs/tr/1.0.x/search.html b/docs/tr/1.0.x/search.html new file mode 100644 index 0000000000..461fc75718 --- /dev/null +++ b/docs/tr/1.0.x/search.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.0.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.0.x/search/index.html b/docs/tr/1.0.x/search/index.html new file mode 100644 index 0000000000..461fc75718 --- /dev/null +++ b/docs/tr/1.0.x/search/index.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.0.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.0.x/site-config.html b/docs/tr/1.0.x/site-config.html new file mode 100644 index 0000000000..e65d05a0e4 --- /dev/null +++ b/docs/tr/1.0.x/site-config.html @@ -0,0 +1,279 @@ +siteConfig.js · Docusaurus

1.0.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url.

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - Kısayol simgesi için url.

+

headerIcon - Başlık gezinme çubuğunda kullanılan simge için url.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - url for your site.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs'
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    { doc: 'doc1', label: 'Docs' },
+    { page: 'help', label: 'Help' },
+    { search: true },
+    { blog: true }
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B'
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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' ],
+  stylesheets: [ 'https://docusaurus.io/style.css' ],
+  facebookAppId: '1615782811974223',
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.0.x/site-config/index.html b/docs/tr/1.0.x/site-config/index.html new file mode 100644 index 0000000000..e65d05a0e4 --- /dev/null +++ b/docs/tr/1.0.x/site-config/index.html @@ -0,0 +1,279 @@ +siteConfig.js · Docusaurus

1.0.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url.

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - Kısayol simgesi için url.

+

headerIcon - Başlık gezinme çubuğunda kullanılan simge için url.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - url for your site.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs'
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    { doc: 'doc1', label: 'Docs' },
+    { page: 'help', label: 'Help' },
+    { search: true },
+    { blog: true }
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B'
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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' ],
+  stylesheets: [ 'https://docusaurus.io/style.css' ],
+  facebookAppId: '1615782811974223',
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.0.x/site-creation.html b/docs/tr/1.0.x/site-creation.html new file mode 100644 index 0000000000..53bddf422e --- /dev/null +++ b/docs/tr/1.0.x/site-creation.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.0.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/tr/1.0.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.0.x/site-config), following the comments included in the [docs](/docs/tr/1.0.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/tr/1.0.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.0.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.0.x/site-creation/index.html b/docs/tr/1.0.x/site-creation/index.html new file mode 100644 index 0000000000..53bddf422e --- /dev/null +++ b/docs/tr/1.0.x/site-creation/index.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.0.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/tr/1.0.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.0.x/site-config), following the comments included in the [docs](/docs/tr/1.0.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/tr/1.0.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.0.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.0.x/site-preparation.html b/docs/tr/1.0.x/site-preparation.html new file mode 100644 index 0000000000..07f8eb91cb --- /dev/null +++ b/docs/tr/1.0.x/site-preparation.html @@ -0,0 +1,139 @@ +Site Preparation · Docusaurus

1.0.x

Translate

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
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js dosyası Docusaurus tarafından üretilen sitenin alt bilgi gibi davranan bir React bileşenidir ve kullanıcı tarafından özelleştirilmelidir.
    • +
  • website/blog-examples-from-docusaurus klasörü markdown ile yazılmış blog postlarının örneklerini içerir.
    • +
  • docs-examples-from-docusaurusklasörü markdown ile yazılmış örnek belgeleme dosyaları içerir.
    • +
  • website/pages klasörü site için örnek üst seviye sayfalar içerir.
    • +
  • website/static klasörü örnek siteye göre statik değerler içerir.
    • +
  • website/siteConfig.js dosyası Docusaurus tarafından kullanılan ana yapılandırma dosyasıdır.
    • +
+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz.

+

website/pages ve website/static klasörlerini sürdürmelisiniz fakat içlerindeki içeriği istediğiniz gibi değiştirebilirsiniz. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.0.x/site-preparation/index.html b/docs/tr/1.0.x/site-preparation/index.html new file mode 100644 index 0000000000..07f8eb91cb --- /dev/null +++ b/docs/tr/1.0.x/site-preparation/index.html @@ -0,0 +1,139 @@ +Site Preparation · Docusaurus

1.0.x

Translate

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
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js dosyası Docusaurus tarafından üretilen sitenin alt bilgi gibi davranan bir React bileşenidir ve kullanıcı tarafından özelleştirilmelidir.
    • +
  • website/blog-examples-from-docusaurus klasörü markdown ile yazılmış blog postlarının örneklerini içerir.
    • +
  • docs-examples-from-docusaurusklasörü markdown ile yazılmış örnek belgeleme dosyaları içerir.
    • +
  • website/pages klasörü site için örnek üst seviye sayfalar içerir.
    • +
  • website/static klasörü örnek siteye göre statik değerler içerir.
    • +
  • website/siteConfig.js dosyası Docusaurus tarafından kullanılan ana yapılandırma dosyasıdır.
    • +
+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz.

+

website/pages ve website/static klasörlerini sürdürmelisiniz fakat içlerindeki içeriği istediğiniz gibi değiştirebilirsiniz. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.0.x/translation.html b/docs/tr/1.0.x/translation.html new file mode 100644 index 0000000000..1b6fccdc33 --- /dev/null +++ b/docs/tr/1.0.x/translation.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.0.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Çevirmek istediğiniz metne sahip sayfalar website/pages/en klasörüne yerleştirilmelidir.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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. Örnek bir circle.yml dosyası:

+
machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+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'i yükleme
+      - sudo apt-get install default-jre
+      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+      - sudo dpkg -i crowdin.deb
+      # tercüme upload/download
+      - crowdin --config crowdin.yaml upload sources --auto-update -b master
+      - crowdin --config crowdin.yaml download -b master
+      # web sitesini yap ve yayınla
+      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.0.x/translation/index.html b/docs/tr/1.0.x/translation/index.html new file mode 100644 index 0000000000..1b6fccdc33 --- /dev/null +++ b/docs/tr/1.0.x/translation/index.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.0.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Çevirmek istediğiniz metne sahip sayfalar website/pages/en klasörüne yerleştirilmelidir.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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. Örnek bir circle.yml dosyası:

+
machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+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'i yükleme
+      - sudo apt-get install default-jre
+      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+      - sudo dpkg -i crowdin.deb
+      # tercüme upload/download
+      - crowdin --config crowdin.yaml upload sources --auto-update -b master
+      - crowdin --config crowdin.yaml download -b master
+      # web sitesini yap ve yayınla
+      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.0.x/versioning.html b/docs/tr/1.0.x/versioning.html new file mode 100644 index 0000000000..bb7f3cf872 --- /dev/null +++ b/docs/tr/1.0.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.0.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs folder. Bu belirli dokümantasyon seti saklanacak ve docs klasöründeki dokümantasyonda değişiklikler yapılsa bile erişilebilir olacaktır.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

Bu şu anda docs klasöründe bulunan tüm dokümanları saklar ve onları sürüm 1.0.0 dokümantasyonları olarak erişilebilir yapar.

+

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.

+

docs klasöründeki dokümanlar next sürümünün parçası olarak kabul edilir ve, örnek olarak, docs/next/doc1.html url'sinden ulaşılabilirler. En son sürümdeki dokümantasyon docs/doc1.html url'sini kullanır.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. 1.0.0 sürümü dokümantasyonu docs/1.0.0/doc1.html url'sini kullanırken 2.0.0 sürümü docs/doc1.html'yi kullanacaktır.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.0.x/versioning/index.html b/docs/tr/1.0.x/versioning/index.html new file mode 100644 index 0000000000..bb7f3cf872 --- /dev/null +++ b/docs/tr/1.0.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.0.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs folder. Bu belirli dokümantasyon seti saklanacak ve docs klasöründeki dokümantasyonda değişiklikler yapılsa bile erişilebilir olacaktır.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

Bu şu anda docs klasöründe bulunan tüm dokümanları saklar ve onları sürüm 1.0.0 dokümantasyonları olarak erişilebilir yapar.

+

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.

+

docs klasöründeki dokümanlar next sürümünün parçası olarak kabul edilir ve, örnek olarak, docs/next/doc1.html url'sinden ulaşılabilirler. En son sürümdeki dokümantasyon docs/doc1.html url'sini kullanır.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. 1.0.0 sürümü dokümantasyonu docs/1.0.0/doc1.html url'sini kullanırken 2.0.0 sürümü docs/doc1.html'yi kullanacaktır.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.1.x/api-pages.html b/docs/tr/1.1.x/api-pages.html new file mode 100644 index 0000000000..4deabb18a2 --- /dev/null +++ b/docs/tr/1.1.x/api-pages.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.1.x

Translate

Pages and Styles

Docusaurus sayfaları React bileşenleri olarak sitenin geri kalanı ile aynı başlık, altbilgi ve stilleri paylaşan website/sayfalar klasörü içine yazmanıza olanak sağlar.

+

URLs for Pages

+

website/sayfalar içerisindeki herhangi bir .js dosyası "sayfalar" dosyasından sonraki yolu kullanarak statik html'e çevrilir. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. Örnek olarak, website/sayfalar/ing/yardım.js sayfası için dosya ${baseUrl}ing/yardım.js url'sinde bulunacaktır aynı zamanda ${baseUrl} içerisindeki ${baseUrl}yardım.js url'si siteConfig.js dosyası içerisinde ayarlı bazUrl alanıdır.

+

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

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.1.x/api-pages/index.html b/docs/tr/1.1.x/api-pages/index.html new file mode 100644 index 0000000000..4deabb18a2 --- /dev/null +++ b/docs/tr/1.1.x/api-pages/index.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.1.x

Translate

Pages and Styles

Docusaurus sayfaları React bileşenleri olarak sitenin geri kalanı ile aynı başlık, altbilgi ve stilleri paylaşan website/sayfalar klasörü içine yazmanıza olanak sağlar.

+

URLs for Pages

+

website/sayfalar içerisindeki herhangi bir .js dosyası "sayfalar" dosyasından sonraki yolu kullanarak statik html'e çevrilir. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. Örnek olarak, website/sayfalar/ing/yardım.js sayfası için dosya ${baseUrl}ing/yardım.js url'sinde bulunacaktır aynı zamanda ${baseUrl} içerisindeki ${baseUrl}yardım.js url'si siteConfig.js dosyası içerisinde ayarlı bazUrl alanıdır.

+

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

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.1.x/blog.html b/docs/tr/1.1.x/blog.html new file mode 100644 index 0000000000..01eb908529 --- /dev/null +++ b/docs/tr/1.1.x/blog.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.1.x

Translate

Adding a Blog

İlk Kurulum

+

Sitenizin blog'unu kurmak için, deponuzun website dizinine blog klasörünü oluşturmakla başlayın.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Yayınlanan tüm blog paylaşımları incelenirken bu paylaşımınızın özet olarak neresinin gösterileceğini belirtmek için <!--truncate--> işaretleyicisini kullanın. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL'
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.1.x/blog/index.html b/docs/tr/1.1.x/blog/index.html new file mode 100644 index 0000000000..01eb908529 --- /dev/null +++ b/docs/tr/1.1.x/blog/index.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.1.x

Translate

Adding a Blog

İlk Kurulum

+

Sitenizin blog'unu kurmak için, deponuzun website dizinine blog klasörünü oluşturmakla başlayın.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Yayınlanan tüm blog paylaşımları incelenirken bu paylaşımınızın özet olarak neresinin gösterileceğini belirtmek için <!--truncate--> işaretleyicisini kullanın. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL'
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.1.x/commands.html b/docs/tr/1.1.x/commands.html new file mode 100644 index 0000000000..7ec639045b --- /dev/null +++ b/docs/tr/1.1.x/commands.html @@ -0,0 +1,226 @@ +CLI Commands · Docusaurus

1.1.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +

  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.

    • +

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    +

    Example

    • +
+
 GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: The git branch associated with the commit that triggered the CI run.
    • +
  • CI_PULL_REQUEST: Expected to be truthy if the current CI run was triggered by a commit in a pull request.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.1.x/commands/index.html b/docs/tr/1.1.x/commands/index.html new file mode 100644 index 0000000000..7ec639045b --- /dev/null +++ b/docs/tr/1.1.x/commands/index.html @@ -0,0 +1,226 @@ +CLI Commands · Docusaurus

1.1.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +

  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.

    • +

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    +

    Example

    • +
+
 GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: The git branch associated with the commit that triggered the CI run.
    • +
  • CI_PULL_REQUEST: Expected to be truthy if the current CI run was triggered by a commit in a pull request.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.1.x/custom-pages.html b/docs/tr/1.1.x/custom-pages.html new file mode 100644 index 0000000000..a65211d823 --- /dev/null +++ b/docs/tr/1.1.x/custom-pages.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.1.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. Alternatif olarak, pages klasörüne de eklenebilirler ve React tarafından işlenmek yerine oldukları gibi kullanılmalıdırlar.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← ÖncekiEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.1.x/custom-pages/index.html b/docs/tr/1.1.x/custom-pages/index.html new file mode 100644 index 0000000000..a65211d823 --- /dev/null +++ b/docs/tr/1.1.x/custom-pages/index.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.1.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. Alternatif olarak, pages klasörüne de eklenebilirler ve React tarafından işlenmek yerine oldukları gibi kullanılmalıdırlar.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← ÖncekiEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.1.x/doc-markdown.html b/docs/tr/1.1.x/doc-markdown.html new file mode 100644 index 0000000000..5669ae6c39 --- /dev/null +++ b/docs/tr/1.1.x/doc-markdown.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.1.x

Translate

Markdown Features

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

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.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog Postları her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

Diğer dokümantasyon dosyaları için bunlar, işlenerek otomatik olarak karşılık gelen html bağlantılarına dönüştürülen diğer dokümantasyon dosyaları ile ilişkili bağlantılar kullanabilirsiniz.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

Bu bağlantılar diğer dokümanlar (hala GitHub içerisinde) için çalışan bağlantılar olacağından GitHub dosyaları arasında dolaşmak istediğinizde işe yarayacaktır ama ama dokümanlar işlendiklerinde doğru html bağlantılarına sahip olacaklar.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Statik varlıklar dokümanlarla gibi ilişkili url'leri kullanarak bağlantılanabilirler. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

API belgeleri için içeriklerin bir tablosu olarak kullanışlı olabilen otomatik oluşturulan linklerin bir listesini yapabilirsiniz.

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.1.x/doc-markdown/index.html b/docs/tr/1.1.x/doc-markdown/index.html new file mode 100644 index 0000000000..5669ae6c39 --- /dev/null +++ b/docs/tr/1.1.x/doc-markdown/index.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.1.x

Translate

Markdown Features

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

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.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog Postları her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

Diğer dokümantasyon dosyaları için bunlar, işlenerek otomatik olarak karşılık gelen html bağlantılarına dönüştürülen diğer dokümantasyon dosyaları ile ilişkili bağlantılar kullanabilirsiniz.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

Bu bağlantılar diğer dokümanlar (hala GitHub içerisinde) için çalışan bağlantılar olacağından GitHub dosyaları arasında dolaşmak istediğinizde işe yarayacaktır ama ama dokümanlar işlendiklerinde doğru html bağlantılarına sahip olacaklar.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Statik varlıklar dokümanlarla gibi ilişkili url'leri kullanarak bağlantılanabilirler. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

API belgeleri için içeriklerin bir tablosu olarak kullanışlı olabilen otomatik oluşturulan linklerin bir listesini yapabilirsiniz.

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.1.x/installation.html b/docs/tr/1.1.x/installation.html new file mode 100644 index 0000000000..1cfb33e0ad --- /dev/null +++ b/docs/tr/1.1.x/installation.html @@ -0,0 +1,154 @@ +Installation · Docusaurus

1.1.x

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    While we recommend Node 8.x or greater, your Node version must at least 6.x.

    +
    2. +

  2. Go into the root of your GitHub repo directory where you will be creating the docs.

    3. +

  3. npx docusaurus-init

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. In your root, rename docs-examples-from-docusaurus to docs.
    2. +
  2. cd website
    3. +
  3. Rename blog-examples-from-docusaurus to blog.
    4. +
  4. Run the local webserver via yarn start or npm start.
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.1.x/installation/index.html b/docs/tr/1.1.x/installation/index.html new file mode 100644 index 0000000000..1cfb33e0ad --- /dev/null +++ b/docs/tr/1.1.x/installation/index.html @@ -0,0 +1,154 @@ +Installation · Docusaurus

1.1.x

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    While we recommend Node 8.x or greater, your Node version must at least 6.x.

    +
    2. +

  2. Go into the root of your GitHub repo directory where you will be creating the docs.

    3. +

  3. npx docusaurus-init

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. In your root, rename docs-examples-from-docusaurus to docs.
    2. +
  2. cd website
    3. +
  3. Rename blog-examples-from-docusaurus to blog.
    4. +
  4. Run the local webserver via yarn start or npm start.
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.1.x/navigation.html b/docs/tr/1.1.x/navigation.html new file mode 100644 index 0000000000..1d12bfdc83 --- /dev/null +++ b/docs/tr/1.1.x/navigation.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.1.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.1.x/navigation/index.html b/docs/tr/1.1.x/navigation/index.html new file mode 100644 index 0000000000..1d12bfdc83 --- /dev/null +++ b/docs/tr/1.1.x/navigation/index.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.1.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.1.x/publishing.html b/docs/tr/1.1.x/publishing.html new file mode 100644 index 0000000000..ad39c1a194 --- /dev/null +++ b/docs/tr/1.1.x/publishing.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.1.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← Creating your siteSonraki →
\ No newline at end of file diff --git a/docs/tr/1.1.x/publishing/index.html b/docs/tr/1.1.x/publishing/index.html new file mode 100644 index 0000000000..ad39c1a194 --- /dev/null +++ b/docs/tr/1.1.x/publishing/index.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.1.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← Creating your siteSonraki →
\ No newline at end of file diff --git a/docs/tr/1.1.x/search.html b/docs/tr/1.1.x/search.html new file mode 100644 index 0000000000..5cdad5f5e5 --- /dev/null +++ b/docs/tr/1.1.x/search.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.1.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.1.x/search/index.html b/docs/tr/1.1.x/search/index.html new file mode 100644 index 0000000000..5cdad5f5e5 --- /dev/null +++ b/docs/tr/1.1.x/search/index.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.1.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.1.x/site-config.html b/docs/tr/1.1.x/site-config.html new file mode 100644 index 0000000000..843a714f1f --- /dev/null +++ b/docs/tr/1.1.x/site-config.html @@ -0,0 +1,287 @@ +siteConfig.js · Docusaurus

1.1.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url.

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - Kısayol simgesi için url.

+

headerIcon - Başlık gezinme çubuğunda kullanılan simge için url.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - url for your site.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.1.x/site-config/index.html b/docs/tr/1.1.x/site-config/index.html new file mode 100644 index 0000000000..843a714f1f --- /dev/null +++ b/docs/tr/1.1.x/site-config/index.html @@ -0,0 +1,287 @@ +siteConfig.js · Docusaurus

1.1.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url.

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - Kısayol simgesi için url.

+

headerIcon - Başlık gezinme çubuğunda kullanılan simge için url.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - url for your site.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.1.x/site-creation.html b/docs/tr/1.1.x/site-creation.html new file mode 100644 index 0000000000..551eb115db --- /dev/null +++ b/docs/tr/1.1.x/site-creation.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.1.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/tr/1.1.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.1.x/site-config), following the comments included in the [docs](/docs/tr/1.1.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/tr/1.1.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.1.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.1.x/site-creation/index.html b/docs/tr/1.1.x/site-creation/index.html new file mode 100644 index 0000000000..551eb115db --- /dev/null +++ b/docs/tr/1.1.x/site-creation/index.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.1.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/tr/1.1.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.1.x/site-config), following the comments included in the [docs](/docs/tr/1.1.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/tr/1.1.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.1.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.1.x/site-preparation.html b/docs/tr/1.1.x/site-preparation.html new file mode 100644 index 0000000000..5adacb1047 --- /dev/null +++ b/docs/tr/1.1.x/site-preparation.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.1.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js dosyası Docusaurus tarafından üretilen sitenin alt bilgi gibi davranan bir React bileşenidir ve kullanıcı tarafından özelleştirilmelidir.
    • +
  • website/blog-examples-from-docusaurus klasörü markdown ile yazılmış blog postlarının örneklerini içerir.
    • +
  • docs-examples-from-docusaurusklasörü markdown ile yazılmış örnek belgeleme dosyaları içerir.
    • +
  • website/pages klasörü site için örnek üst seviye sayfalar içerir.
    • +
  • website/static klasörü örnek siteye göre statik değerler içerir.
    • +
  • website/siteConfig.js dosyası Docusaurus tarafından kullanılan ana yapılandırma dosyasıdır.
    • +
+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz.

+

website/pages ve website/static klasörlerini sürdürmelisiniz fakat içlerindeki içeriği istediğiniz gibi değiştirebilirsiniz. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.1.x/site-preparation/index.html b/docs/tr/1.1.x/site-preparation/index.html new file mode 100644 index 0000000000..5adacb1047 --- /dev/null +++ b/docs/tr/1.1.x/site-preparation/index.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.1.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js dosyası Docusaurus tarafından üretilen sitenin alt bilgi gibi davranan bir React bileşenidir ve kullanıcı tarafından özelleştirilmelidir.
    • +
  • website/blog-examples-from-docusaurus klasörü markdown ile yazılmış blog postlarının örneklerini içerir.
    • +
  • docs-examples-from-docusaurusklasörü markdown ile yazılmış örnek belgeleme dosyaları içerir.
    • +
  • website/pages klasörü site için örnek üst seviye sayfalar içerir.
    • +
  • website/static klasörü örnek siteye göre statik değerler içerir.
    • +
  • website/siteConfig.js dosyası Docusaurus tarafından kullanılan ana yapılandırma dosyasıdır.
    • +
+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz.

+

website/pages ve website/static klasörlerini sürdürmelisiniz fakat içlerindeki içeriği istediğiniz gibi değiştirebilirsiniz. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.1.x/translation.html b/docs/tr/1.1.x/translation.html new file mode 100644 index 0000000000..29d19a6bda --- /dev/null +++ b/docs/tr/1.1.x/translation.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.1.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Çevirmek istediğiniz metne sahip sayfalar website/pages/en klasörüne yerleştirilmelidir.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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. Örnek bir circle.yml dosyası:

+
machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+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'i yükleme
+      - sudo apt-get install default-jre
+      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+      - sudo dpkg -i crowdin.deb
+      # tercüme upload/download
+      - crowdin --config crowdin.yaml upload sources --auto-update -b master
+      - crowdin --config crowdin.yaml download -b master
+      # web sitesini yap ve yayınla
+      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.1.x/translation/index.html b/docs/tr/1.1.x/translation/index.html new file mode 100644 index 0000000000..29d19a6bda --- /dev/null +++ b/docs/tr/1.1.x/translation/index.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.1.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Çevirmek istediğiniz metne sahip sayfalar website/pages/en klasörüne yerleştirilmelidir.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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. Örnek bir circle.yml dosyası:

+
machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+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'i yükleme
+      - sudo apt-get install default-jre
+      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+      - sudo dpkg -i crowdin.deb
+      # tercüme upload/download
+      - crowdin --config crowdin.yaml upload sources --auto-update -b master
+      - crowdin --config crowdin.yaml download -b master
+      # web sitesini yap ve yayınla
+      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.1.x/versioning.html b/docs/tr/1.1.x/versioning.html new file mode 100644 index 0000000000..26bffff0d0 --- /dev/null +++ b/docs/tr/1.1.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.1.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs folder. Bu belirli dokümantasyon seti saklanacak ve docs klasöründeki dokümantasyonda değişiklikler yapılsa bile erişilebilir olacaktır.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

Bu şu anda docs klasöründe bulunan tüm dokümanları saklar ve onları sürüm 1.0.0 dokümantasyonları olarak erişilebilir yapar.

+

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.

+

docs klasöründeki dokümanlar next sürümünün parçası olarak kabul edilir ve, örnek olarak, docs/next/doc1.html url'sinden ulaşılabilirler. En son sürümdeki dokümantasyon docs/doc1.html url'sini kullanır.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. 1.0.0 sürümü dokümantasyonu docs/1.0.0/doc1.html url'sini kullanırken 2.0.0 sürümü docs/doc1.html'yi kullanacaktır.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.1.x/versioning/index.html b/docs/tr/1.1.x/versioning/index.html new file mode 100644 index 0000000000..26bffff0d0 --- /dev/null +++ b/docs/tr/1.1.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.1.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs folder. Bu belirli dokümantasyon seti saklanacak ve docs klasöründeki dokümantasyonda değişiklikler yapılsa bile erişilebilir olacaktır.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

Bu şu anda docs klasöründe bulunan tüm dokümanları saklar ve onları sürüm 1.0.0 dokümantasyonları olarak erişilebilir yapar.

+

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.

+

docs klasöründeki dokümanlar next sürümünün parçası olarak kabul edilir ve, örnek olarak, docs/next/doc1.html url'sinden ulaşılabilirler. En son sürümdeki dokümantasyon docs/doc1.html url'sini kullanır.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. 1.0.0 sürümü dokümantasyonu docs/1.0.0/doc1.html url'sini kullanırken 2.0.0 sürümü docs/doc1.html'yi kullanacaktır.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.2.x/api-pages.html b/docs/tr/1.2.x/api-pages.html new file mode 100644 index 0000000000..21ce01ebac --- /dev/null +++ b/docs/tr/1.2.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.2.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.2.x/api-pages/index.html b/docs/tr/1.2.x/api-pages/index.html new file mode 100644 index 0000000000..21ce01ebac --- /dev/null +++ b/docs/tr/1.2.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.2.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.2.x/blog.html b/docs/tr/1.2.x/blog.html new file mode 100644 index 0000000000..e902447c70 --- /dev/null +++ b/docs/tr/1.2.x/blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.2.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.2.x/blog/index.html b/docs/tr/1.2.x/blog/index.html new file mode 100644 index 0000000000..e902447c70 --- /dev/null +++ b/docs/tr/1.2.x/blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.2.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.2.x/commands.html b/docs/tr/1.2.x/commands.html new file mode 100644 index 0000000000..dd0ff63c97 --- /dev/null +++ b/docs/tr/1.2.x/commands.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.2.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.2.x/commands/index.html b/docs/tr/1.2.x/commands/index.html new file mode 100644 index 0000000000..dd0ff63c97 --- /dev/null +++ b/docs/tr/1.2.x/commands/index.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.2.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.2.x/custom-pages.html b/docs/tr/1.2.x/custom-pages.html new file mode 100644 index 0000000000..879a2c00af --- /dev/null +++ b/docs/tr/1.2.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.2.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← ÖncekiEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.2.x/custom-pages/index.html b/docs/tr/1.2.x/custom-pages/index.html new file mode 100644 index 0000000000..879a2c00af --- /dev/null +++ b/docs/tr/1.2.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.2.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← ÖncekiEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.2.x/doc-markdown.html b/docs/tr/1.2.x/doc-markdown.html new file mode 100644 index 0000000000..3ceefd65b3 --- /dev/null +++ b/docs/tr/1.2.x/doc-markdown.html @@ -0,0 +1,234 @@ +Markdown Features · Docusaurus

1.2.x

Translate

Markdown Features

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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>. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.2.x/doc-markdown/index.html b/docs/tr/1.2.x/doc-markdown/index.html new file mode 100644 index 0000000000..3ceefd65b3 --- /dev/null +++ b/docs/tr/1.2.x/doc-markdown/index.html @@ -0,0 +1,234 @@ +Markdown Features · Docusaurus

1.2.x

Translate

Markdown Features

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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>. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.2.x/installation.html b/docs/tr/1.2.x/installation.html new file mode 100644 index 0000000000..c237d20872 --- /dev/null +++ b/docs/tr/1.2.x/installation.html @@ -0,0 +1,181 @@ +Installation · Docusaurus

1.2.x

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Go into the root of your GitHub repo directory where you will be creating the docs.

    3. +

  3. npx docusaurus-init

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. In your root, rename docs-examples-from-docusaurus to docs.
    2. +
  2. cd website
    3. +
  3. Rename blog-examples-from-docusaurus to blog.
    4. +
  4. Run the local webserver via yarn start or npm start.
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.2.x/installation/index.html b/docs/tr/1.2.x/installation/index.html new file mode 100644 index 0000000000..c237d20872 --- /dev/null +++ b/docs/tr/1.2.x/installation/index.html @@ -0,0 +1,181 @@ +Installation · Docusaurus

1.2.x

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Go into the root of your GitHub repo directory where you will be creating the docs.

    3. +

  3. npx docusaurus-init

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. In your root, rename docs-examples-from-docusaurus to docs.
    2. +
  2. cd website
    3. +
  3. Rename blog-examples-from-docusaurus to blog.
    4. +
  4. Run the local webserver via yarn start or npm start.
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.2.x/navigation.html b/docs/tr/1.2.x/navigation.html new file mode 100644 index 0000000000..e5bc21616c --- /dev/null +++ b/docs/tr/1.2.x/navigation.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.2.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.2.x/navigation/index.html b/docs/tr/1.2.x/navigation/index.html new file mode 100644 index 0000000000..e5bc21616c --- /dev/null +++ b/docs/tr/1.2.x/navigation/index.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.2.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.2.x/publishing.html b/docs/tr/1.2.x/publishing.html new file mode 100644 index 0000000000..f717263b2e --- /dev/null +++ b/docs/tr/1.2.x/publishing.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.2.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteSonraki →
\ No newline at end of file diff --git a/docs/tr/1.2.x/publishing/index.html b/docs/tr/1.2.x/publishing/index.html new file mode 100644 index 0000000000..f717263b2e --- /dev/null +++ b/docs/tr/1.2.x/publishing/index.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.2.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteSonraki →
\ No newline at end of file diff --git a/docs/tr/1.2.x/search.html b/docs/tr/1.2.x/search.html new file mode 100644 index 0000000000..e7aa3fa56d --- /dev/null +++ b/docs/tr/1.2.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.2.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.2.x/search/index.html b/docs/tr/1.2.x/search/index.html new file mode 100644 index 0000000000..e7aa3fa56d --- /dev/null +++ b/docs/tr/1.2.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.2.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.2.x/site-config.html b/docs/tr/1.2.x/site-config.html new file mode 100644 index 0000000000..668ff145e1 --- /dev/null +++ b/docs/tr/1.2.x/site-config.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.2.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url.

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - URL for site favicon.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - URL for your website.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.2.x/site-config/index.html b/docs/tr/1.2.x/site-config/index.html new file mode 100644 index 0000000000..668ff145e1 --- /dev/null +++ b/docs/tr/1.2.x/site-config/index.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.2.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url.

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - URL for site favicon.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - URL for your website.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.2.x/site-creation.html b/docs/tr/1.2.x/site-creation.html new file mode 100644 index 0000000000..98da5f64b6 --- /dev/null +++ b/docs/tr/1.2.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.2.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.2.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.2.x/site-config), following the comments included in the [docs](/docs/tr/1.2.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.2.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.2.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.2.x/site-creation/index.html b/docs/tr/1.2.x/site-creation/index.html new file mode 100644 index 0000000000..98da5f64b6 --- /dev/null +++ b/docs/tr/1.2.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.2.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.2.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.2.x/site-config), following the comments included in the [docs](/docs/tr/1.2.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.2.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.2.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.2.x/site-preparation.html b/docs/tr/1.2.x/site-preparation.html new file mode 100644 index 0000000000..c7de481e8c --- /dev/null +++ b/docs/tr/1.2.x/site-preparation.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.2.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js dosyası Docusaurus tarafından üretilen sitenin alt bilgi gibi davranan bir React bileşenidir ve kullanıcı tarafından özelleştirilmelidir.
    • +
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • +
  • The website/pages directory contains example top-level pages for the site.
    • +
  • The website/static directory contains static assets used by the example site.
    • +
  • website/siteConfig.js dosyası Docusaurus tarafından kullanılan ana yapılandırma dosyasıdır.
    • +
+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.2.x/site-preparation/index.html b/docs/tr/1.2.x/site-preparation/index.html new file mode 100644 index 0000000000..c7de481e8c --- /dev/null +++ b/docs/tr/1.2.x/site-preparation/index.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.2.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js dosyası Docusaurus tarafından üretilen sitenin alt bilgi gibi davranan bir React bileşenidir ve kullanıcı tarafından özelleştirilmelidir.
    • +
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • +
  • The website/pages directory contains example top-level pages for the site.
    • +
  • The website/static directory contains static assets used by the example site.
    • +
  • website/siteConfig.js dosyası Docusaurus tarafından kullanılan ana yapılandırma dosyasıdır.
    • +
+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.2.x/translation.html b/docs/tr/1.2.x/translation.html new file mode 100644 index 0000000000..fee4b61092 --- /dev/null +++ b/docs/tr/1.2.x/translation.html @@ -0,0 +1,305 @@ +Translations & Localization · Docusaurus

1.2.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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. Örnek bir circle.yml dosyası:

+
machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+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'i yükleme
+      - sudo apt-get install default-jre
+      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+      - sudo dpkg -i crowdin.deb
+      # tercüme upload/download
+      - crowdin --config crowdin.yaml upload sources --auto-update -b master
+      - crowdin --config crowdin.yaml download -b master
+      # web sitesini yap ve yayınla
+      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.2.x/translation/index.html b/docs/tr/1.2.x/translation/index.html new file mode 100644 index 0000000000..fee4b61092 --- /dev/null +++ b/docs/tr/1.2.x/translation/index.html @@ -0,0 +1,305 @@ +Translations & Localization · Docusaurus

1.2.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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. Örnek bir circle.yml dosyası:

+
machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+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'i yükleme
+      - sudo apt-get install default-jre
+      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+      - sudo dpkg -i crowdin.deb
+      # tercüme upload/download
+      - crowdin --config crowdin.yaml upload sources --auto-update -b master
+      - crowdin --config crowdin.yaml download -b master
+      # web sitesini yap ve yayınla
+      - cd website && GIT_USER=test-site-bot npm run publish-gh-pages
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.2.x/versioning.html b/docs/tr/1.2.x/versioning.html new file mode 100644 index 0000000000..2f4a5e9cd6 --- /dev/null +++ b/docs/tr/1.2.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.2.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.2.x/versioning/index.html b/docs/tr/1.2.x/versioning/index.html new file mode 100644 index 0000000000..2f4a5e9cd6 --- /dev/null +++ b/docs/tr/1.2.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.2.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.3.x/adding-blog.html b/docs/tr/1.3.x/adding-blog.html new file mode 100644 index 0000000000..992408b001 --- /dev/null +++ b/docs/tr/1.3.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.3.x/adding-blog/index.html b/docs/tr/1.3.x/adding-blog/index.html new file mode 100644 index 0000000000..992408b001 --- /dev/null +++ b/docs/tr/1.3.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Publishing your siteCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.3.x/api-pages.html b/docs/tr/1.3.x/api-pages.html new file mode 100644 index 0000000000..6e258ed18d --- /dev/null +++ b/docs/tr/1.3.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.3.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.3.x/api-pages/index.html b/docs/tr/1.3.x/api-pages/index.html new file mode 100644 index 0000000000..6e258ed18d --- /dev/null +++ b/docs/tr/1.3.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.3.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.3.x/blog.html b/docs/tr/1.3.x/blog.html new file mode 100644 index 0000000000..a1e359b656 --- /dev/null +++ b/docs/tr/1.3.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.3.x/blog/index.html b/docs/tr/1.3.x/blog/index.html new file mode 100644 index 0000000000..a1e359b656 --- /dev/null +++ b/docs/tr/1.3.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.3.x/commands.html b/docs/tr/1.3.x/commands.html new file mode 100644 index 0000000000..ca5ad7a5cd --- /dev/null +++ b/docs/tr/1.3.x/commands.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.3.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.3.x/commands/index.html b/docs/tr/1.3.x/commands/index.html new file mode 100644 index 0000000000..ca5ad7a5cd --- /dev/null +++ b/docs/tr/1.3.x/commands/index.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.3.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.3.x/custom-pages.html b/docs/tr/1.3.x/custom-pages.html new file mode 100644 index 0000000000..dcfd077ab2 --- /dev/null +++ b/docs/tr/1.3.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.3.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.3.x/custom-pages/index.html b/docs/tr/1.3.x/custom-pages/index.html new file mode 100644 index 0000000000..dcfd077ab2 --- /dev/null +++ b/docs/tr/1.3.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.3.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.3.x/doc-markdown.html b/docs/tr/1.3.x/doc-markdown.html new file mode 100644 index 0000000000..d449ef4db3 --- /dev/null +++ b/docs/tr/1.3.x/doc-markdown.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.3.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.3.x/doc-markdown/index.html b/docs/tr/1.3.x/doc-markdown/index.html new file mode 100644 index 0000000000..d449ef4db3 --- /dev/null +++ b/docs/tr/1.3.x/doc-markdown/index.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.3.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.3.x/installation.html b/docs/tr/1.3.x/installation.html new file mode 100644 index 0000000000..db4b64d3cc --- /dev/null +++ b/docs/tr/1.3.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.3.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your the directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.3.x/installation/index.html b/docs/tr/1.3.x/installation/index.html new file mode 100644 index 0000000000..db4b64d3cc --- /dev/null +++ b/docs/tr/1.3.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.3.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your the directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.3.x/navigation.html b/docs/tr/1.3.x/navigation.html new file mode 100644 index 0000000000..6ab42be639 --- /dev/null +++ b/docs/tr/1.3.x/navigation.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.3.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.3.x/navigation/index.html b/docs/tr/1.3.x/navigation/index.html new file mode 100644 index 0000000000..6ab42be639 --- /dev/null +++ b/docs/tr/1.3.x/navigation/index.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.3.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.3.x/publishing.html b/docs/tr/1.3.x/publishing.html new file mode 100644 index 0000000000..f272c1fb35 --- /dev/null +++ b/docs/tr/1.3.x/publishing.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.3.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.3.x/publishing/index.html b/docs/tr/1.3.x/publishing/index.html new file mode 100644 index 0000000000..f272c1fb35 --- /dev/null +++ b/docs/tr/1.3.x/publishing/index.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.3.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.3.x/search.html b/docs/tr/1.3.x/search.html new file mode 100644 index 0000000000..6754c20796 --- /dev/null +++ b/docs/tr/1.3.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.3.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.3.x/search/index.html b/docs/tr/1.3.x/search/index.html new file mode 100644 index 0000000000..6754c20796 --- /dev/null +++ b/docs/tr/1.3.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.3.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.3.x/site-config.html b/docs/tr/1.3.x/site-config.html new file mode 100644 index 0000000000..b07a601aa5 --- /dev/null +++ b/docs/tr/1.3.x/site-config.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.3.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url. For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - URL for site favicon.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - URL for your website.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.3.x/site-config/index.html b/docs/tr/1.3.x/site-config/index.html new file mode 100644 index 0000000000..b07a601aa5 --- /dev/null +++ b/docs/tr/1.3.x/site-config/index.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.3.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url. For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - URL for site favicon.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - URL for your website.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

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

+

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

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.3.x/site-creation.html b/docs/tr/1.3.x/site-creation.html new file mode 100644 index 0000000000..f684e20d0c --- /dev/null +++ b/docs/tr/1.3.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.3.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.3.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.3.x/site-config), following the comments included in the [docs](/docs/tr/1.3.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.3.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.3.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.3.x/site-creation/index.html b/docs/tr/1.3.x/site-creation/index.html new file mode 100644 index 0000000000..f684e20d0c --- /dev/null +++ b/docs/tr/1.3.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.3.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.3.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.3.x/site-config), following the comments included in the [docs](/docs/tr/1.3.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.3.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.3.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.3.x/site-preparation.html b/docs/tr/1.3.x/site-preparation.html new file mode 100644 index 0000000000..6ff391085d --- /dev/null +++ b/docs/tr/1.3.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.3.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.3.x/site-preparation/index.html b/docs/tr/1.3.x/site-preparation/index.html new file mode 100644 index 0000000000..6ff391085d --- /dev/null +++ b/docs/tr/1.3.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.3.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.3.x/translation.html b/docs/tr/1.3.x/translation.html new file mode 100644 index 0000000000..855c6c3b7f --- /dev/null +++ b/docs/tr/1.3.x/translation.html @@ -0,0 +1,319 @@ +Translations & Localization · Docusaurus

1.3.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.3.x/translation/index.html b/docs/tr/1.3.x/translation/index.html new file mode 100644 index 0000000000..855c6c3b7f --- /dev/null +++ b/docs/tr/1.3.x/translation/index.html @@ -0,0 +1,319 @@ +Translations & Localization · Docusaurus

1.3.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.3.x/versioning.html b/docs/tr/1.3.x/versioning.html new file mode 100644 index 0000000000..faaabefe18 --- /dev/null +++ b/docs/tr/1.3.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.3.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.3.x/versioning/index.html b/docs/tr/1.3.x/versioning/index.html new file mode 100644 index 0000000000..faaabefe18 --- /dev/null +++ b/docs/tr/1.3.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.3.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.4.x/adding-blog.html b/docs/tr/1.4.x/adding-blog.html new file mode 100644 index 0000000000..dd215f928d --- /dev/null +++ b/docs/tr/1.4.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.4.x/adding-blog/index.html b/docs/tr/1.4.x/adding-blog/index.html new file mode 100644 index 0000000000..dd215f928d --- /dev/null +++ b/docs/tr/1.4.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.4.x/api-pages.html b/docs/tr/1.4.x/api-pages.html new file mode 100644 index 0000000000..39c828fee8 --- /dev/null +++ b/docs/tr/1.4.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.4.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.4.x/api-pages/index.html b/docs/tr/1.4.x/api-pages/index.html new file mode 100644 index 0000000000..39c828fee8 --- /dev/null +++ b/docs/tr/1.4.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.4.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.4.x/blog.html b/docs/tr/1.4.x/blog.html new file mode 100644 index 0000000000..04ffe4228b --- /dev/null +++ b/docs/tr/1.4.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.4.x/blog/index.html b/docs/tr/1.4.x/blog/index.html new file mode 100644 index 0000000000..04ffe4228b --- /dev/null +++ b/docs/tr/1.4.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.4.x/commands.html b/docs/tr/1.4.x/commands.html new file mode 100644 index 0000000000..7ccfa76e6c --- /dev/null +++ b/docs/tr/1.4.x/commands.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.4.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.4.x/commands/index.html b/docs/tr/1.4.x/commands/index.html new file mode 100644 index 0000000000..7ccfa76e6c --- /dev/null +++ b/docs/tr/1.4.x/commands/index.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.4.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.4.x/custom-pages.html b/docs/tr/1.4.x/custom-pages.html new file mode 100644 index 0000000000..e0e3666134 --- /dev/null +++ b/docs/tr/1.4.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.4.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.4.x/custom-pages/index.html b/docs/tr/1.4.x/custom-pages/index.html new file mode 100644 index 0000000000..e0e3666134 --- /dev/null +++ b/docs/tr/1.4.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.4.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.4.x/doc-markdown.html b/docs/tr/1.4.x/doc-markdown.html new file mode 100644 index 0000000000..2836bac0d3 --- /dev/null +++ b/docs/tr/1.4.x/doc-markdown.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.4.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.4.x/doc-markdown/index.html b/docs/tr/1.4.x/doc-markdown/index.html new file mode 100644 index 0000000000..2836bac0d3 --- /dev/null +++ b/docs/tr/1.4.x/doc-markdown/index.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.4.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.4.x/docker.html b/docs/tr/1.4.x/docker.html new file mode 100644 index 0000000000..d1f27eecee --- /dev/null +++ b/docs/tr/1.4.x/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.4.x

Translate

Docker

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

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.4.x/docker/index.html b/docs/tr/1.4.x/docker/index.html new file mode 100644 index 0000000000..d1f27eecee --- /dev/null +++ b/docs/tr/1.4.x/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.4.x

Translate

Docker

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

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.4.x/installation.html b/docs/tr/1.4.x/installation.html new file mode 100644 index 0000000000..3e3913c91a --- /dev/null +++ b/docs/tr/1.4.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.4.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your the directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.4.x/installation/index.html b/docs/tr/1.4.x/installation/index.html new file mode 100644 index 0000000000..3e3913c91a --- /dev/null +++ b/docs/tr/1.4.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.4.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your the directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.4.x/navigation.html b/docs/tr/1.4.x/navigation.html new file mode 100644 index 0000000000..e04fe4ba59 --- /dev/null +++ b/docs/tr/1.4.x/navigation.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.4.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.4.x/navigation/index.html b/docs/tr/1.4.x/navigation/index.html new file mode 100644 index 0000000000..e04fe4ba59 --- /dev/null +++ b/docs/tr/1.4.x/navigation/index.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.4.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.4.x/publishing.html b/docs/tr/1.4.x/publishing.html new file mode 100644 index 0000000000..d9d7474089 --- /dev/null +++ b/docs/tr/1.4.x/publishing.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.4.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.4.x/publishing/index.html b/docs/tr/1.4.x/publishing/index.html new file mode 100644 index 0000000000..d9d7474089 --- /dev/null +++ b/docs/tr/1.4.x/publishing/index.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.4.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

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

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

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

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.4.x/search.html b/docs/tr/1.4.x/search.html new file mode 100644 index 0000000000..3ce73c3e3f --- /dev/null +++ b/docs/tr/1.4.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.4.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.4.x/search/index.html b/docs/tr/1.4.x/search/index.html new file mode 100644 index 0000000000..3ce73c3e3f --- /dev/null +++ b/docs/tr/1.4.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.4.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.4.x/site-config.html b/docs/tr/1.4.x/site-config.html new file mode 100644 index 0000000000..67281db105 --- /dev/null +++ b/docs/tr/1.4.x/site-config.html @@ -0,0 +1,312 @@ +siteConfig.js · Docusaurus

1.4.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url. For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - URL for site favicon.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - URL for your website.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

enableUpdateTime - An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last Updated: dd/mm/yyyy hh:MM:ss Z.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

manifest - Path to your web app manifest (e.g., /manifest.json). This will add a <link> tag to <head> with rel as "manifest" and content as the provided path.

+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

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

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src: 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true
+    }
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: "text/css"
+    }
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.4.x/site-config/index.html b/docs/tr/1.4.x/site-config/index.html new file mode 100644 index 0000000000..67281db105 --- /dev/null +++ b/docs/tr/1.4.x/site-config/index.html @@ -0,0 +1,312 @@ +siteConfig.js · Docusaurus

1.4.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl - Siteniz için temel Url. For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - Site için renk yapılandırılması.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

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

+

favicon - URL for site favicon.

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

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.

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

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

+

tagline - Web siteniz için slogan.

+

title - Web siteniz için başlık.

+

url - URL for your website.

+

İsteğe Bağlı Alanlar

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

enableUpdateTime - An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last Updated: dd/mm/yyyy hh:MM:ss Z.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

manifest - Path to your web app manifest (e.g., /manifest.json). This will add a <link> tag to <head> with rel as "manifest" and content as the provided path.

+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

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

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src: 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true
+    }
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: "text/css"
+    }
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.4.x/site-creation.html b/docs/tr/1.4.x/site-creation.html new file mode 100644 index 0000000000..968571cb45 --- /dev/null +++ b/docs/tr/1.4.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.4.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.4.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.4.x/site-config), following the comments included in the [docs](/docs/tr/1.4.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.4.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.4.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.4.x/site-creation/index.html b/docs/tr/1.4.x/site-creation/index.html new file mode 100644 index 0000000000..968571cb45 --- /dev/null +++ b/docs/tr/1.4.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.4.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.4.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.4.x/site-config), following the comments included in the [docs](/docs/tr/1.4.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.4.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.4.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.4.x/site-preparation.html b/docs/tr/1.4.x/site-preparation.html new file mode 100644 index 0000000000..23f3ff8392 --- /dev/null +++ b/docs/tr/1.4.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.4.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.4.x/site-preparation/index.html b/docs/tr/1.4.x/site-preparation/index.html new file mode 100644 index 0000000000..23f3ff8392 --- /dev/null +++ b/docs/tr/1.4.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.4.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.4.x/translation.html b/docs/tr/1.4.x/translation.html new file mode 100644 index 0000000000..012f41a227 --- /dev/null +++ b/docs/tr/1.4.x/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.4.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.4.x/translation/index.html b/docs/tr/1.4.x/translation/index.html new file mode 100644 index 0000000000..012f41a227 --- /dev/null +++ b/docs/tr/1.4.x/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.4.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.4.x/versioning.html b/docs/tr/1.4.x/versioning.html new file mode 100644 index 0000000000..f53cbc2561 --- /dev/null +++ b/docs/tr/1.4.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.4.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.4.x/versioning/index.html b/docs/tr/1.4.x/versioning/index.html new file mode 100644 index 0000000000..f53cbc2561 --- /dev/null +++ b/docs/tr/1.4.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.4.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.5.x/adding-blog.html b/docs/tr/1.5.x/adding-blog.html new file mode 100644 index 0000000000..bd0a3cc10c --- /dev/null +++ b/docs/tr/1.5.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.5.x/adding-blog/index.html b/docs/tr/1.5.x/adding-blog/index.html new file mode 100644 index 0000000000..bd0a3cc10c --- /dev/null +++ b/docs/tr/1.5.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.5.x/api-pages.html b/docs/tr/1.5.x/api-pages.html new file mode 100644 index 0000000000..baca98211a --- /dev/null +++ b/docs/tr/1.5.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.5.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.5.x/api-pages/index.html b/docs/tr/1.5.x/api-pages/index.html new file mode 100644 index 0000000000..baca98211a --- /dev/null +++ b/docs/tr/1.5.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.5.x

Translate

Pages and Styles

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

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.5.x/blog.html b/docs/tr/1.5.x/blog.html new file mode 100644 index 0000000000..5b0f31bab1 --- /dev/null +++ b/docs/tr/1.5.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.5.x/blog/index.html b/docs/tr/1.5.x/blog/index.html new file mode 100644 index 0000000000..5b0f31bab1 --- /dev/null +++ b/docs/tr/1.5.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.5.x/commands.html b/docs/tr/1.5.x/commands.html new file mode 100644 index 0000000000..f832fecc7c --- /dev/null +++ b/docs/tr/1.5.x/commands.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.5.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.5.x/commands/index.html b/docs/tr/1.5.x/commands/index.html new file mode 100644 index 0000000000..f832fecc7c --- /dev/null +++ b/docs/tr/1.5.x/commands/index.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.5.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.5.x/custom-pages.html b/docs/tr/1.5.x/custom-pages.html new file mode 100644 index 0000000000..be073c443a --- /dev/null +++ b/docs/tr/1.5.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.5.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.5.x/custom-pages/index.html b/docs/tr/1.5.x/custom-pages/index.html new file mode 100644 index 0000000000..be073c443a --- /dev/null +++ b/docs/tr/1.5.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.5.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.5.x/doc-markdown.html b/docs/tr/1.5.x/doc-markdown.html new file mode 100644 index 0000000000..aa551f7297 --- /dev/null +++ b/docs/tr/1.5.x/doc-markdown.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.5.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.5.x/doc-markdown/index.html b/docs/tr/1.5.x/doc-markdown/index.html new file mode 100644 index 0000000000..aa551f7297 --- /dev/null +++ b/docs/tr/1.5.x/doc-markdown/index.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.5.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

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.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.5.x/docker.html b/docs/tr/1.5.x/docker.html new file mode 100644 index 0000000000..7143296beb --- /dev/null +++ b/docs/tr/1.5.x/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.5.x

Translate

Docker

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

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.5.x/docker/index.html b/docs/tr/1.5.x/docker/index.html new file mode 100644 index 0000000000..7143296beb --- /dev/null +++ b/docs/tr/1.5.x/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.5.x

Translate

Docker

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

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.5.x/installation.html b/docs/tr/1.5.x/installation.html new file mode 100644 index 0000000000..fb7462ad33 --- /dev/null +++ b/docs/tr/1.5.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.5.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.5.x/installation/index.html b/docs/tr/1.5.x/installation/index.html new file mode 100644 index 0000000000..fb7462ad33 --- /dev/null +++ b/docs/tr/1.5.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.5.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.5.x/navigation.html b/docs/tr/1.5.x/navigation.html new file mode 100644 index 0000000000..52f4b30e4d --- /dev/null +++ b/docs/tr/1.5.x/navigation.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.5.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.5.x/navigation/index.html b/docs/tr/1.5.x/navigation/index.html new file mode 100644 index 0000000000..52f4b30e4d --- /dev/null +++ b/docs/tr/1.5.x/navigation/index.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.5.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.5.x/publishing.html b/docs/tr/1.5.x/publishing.html new file mode 100644 index 0000000000..659e146d82 --- /dev/null +++ b/docs/tr/1.5.x/publishing.html @@ -0,0 +1,311 @@ +Publishing your site · Docusaurus

1.5.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

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

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

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.5.x/publishing/index.html b/docs/tr/1.5.x/publishing/index.html new file mode 100644 index 0000000000..659e146d82 --- /dev/null +++ b/docs/tr/1.5.x/publishing/index.html @@ -0,0 +1,311 @@ +Publishing your site · Docusaurus

1.5.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

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

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

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.5.x/search.html b/docs/tr/1.5.x/search.html new file mode 100644 index 0000000000..1fb4fdbf44 --- /dev/null +++ b/docs/tr/1.5.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.5.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.5.x/search/index.html b/docs/tr/1.5.x/search/index.html new file mode 100644 index 0000000000..1fb4fdbf44 --- /dev/null +++ b/docs/tr/1.5.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.5.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.5.x/site-config.html b/docs/tr/1.5.x/site-config.html new file mode 100644 index 0000000000..1de1508e9f --- /dev/null +++ b/docs/tr/1.5.x/site-config.html @@ -0,0 +1,384 @@ +siteConfig.js · Docusaurus

1.5.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

noIndex [boolean]

+

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.

+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

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

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

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

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.5.x/site-config/index.html b/docs/tr/1.5.x/site-config/index.html new file mode 100644 index 0000000000..1de1508e9f --- /dev/null +++ b/docs/tr/1.5.x/site-config/index.html @@ -0,0 +1,384 @@ +siteConfig.js · Docusaurus

1.5.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

noIndex [boolean]

+

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.

+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

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

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

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

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.5.x/site-creation.html b/docs/tr/1.5.x/site-creation.html new file mode 100644 index 0000000000..fc26ad194b --- /dev/null +++ b/docs/tr/1.5.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.5.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.5.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.5.x/site-config), following the comments included in the [docs](/docs/tr/1.5.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.5.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.5.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.5.x/site-creation/index.html b/docs/tr/1.5.x/site-creation/index.html new file mode 100644 index 0000000000..fc26ad194b --- /dev/null +++ b/docs/tr/1.5.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.5.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.5.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.5.x/site-config), following the comments included in the [docs](/docs/tr/1.5.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.5.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.5.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.5.x/site-preparation.html b/docs/tr/1.5.x/site-preparation.html new file mode 100644 index 0000000000..1970b83281 --- /dev/null +++ b/docs/tr/1.5.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.5.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.5.x/site-preparation/index.html b/docs/tr/1.5.x/site-preparation/index.html new file mode 100644 index 0000000000..1970b83281 --- /dev/null +++ b/docs/tr/1.5.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.5.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files, but may edit them as you wish.

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. At the bare minimum you should have an en/index.js or en/index.html file inside website/pages and an image to use as your header icon inside website/static.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.5.x/translation.html b/docs/tr/1.5.x/translation.html new file mode 100644 index 0000000000..750fa1ed3d --- /dev/null +++ b/docs/tr/1.5.x/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.5.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.5.x/translation/index.html b/docs/tr/1.5.x/translation/index.html new file mode 100644 index 0000000000..750fa1ed3d --- /dev/null +++ b/docs/tr/1.5.x/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.5.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.5.x/versioning.html b/docs/tr/1.5.x/versioning.html new file mode 100644 index 0000000000..2c80cdb0bc --- /dev/null +++ b/docs/tr/1.5.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.5.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.5.x/versioning/index.html b/docs/tr/1.5.x/versioning/index.html new file mode 100644 index 0000000000..2c80cdb0bc --- /dev/null +++ b/docs/tr/1.5.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.5.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.6.x/adding-blog.html b/docs/tr/1.6.x/adding-blog.html new file mode 100644 index 0000000000..ca7611d663 --- /dev/null +++ b/docs/tr/1.6.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.6.x/adding-blog/index.html b/docs/tr/1.6.x/adding-blog/index.html new file mode 100644 index 0000000000..ca7611d663 --- /dev/null +++ b/docs/tr/1.6.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.6.x/api-pages.html b/docs/tr/1.6.x/api-pages.html new file mode 100644 index 0000000000..cfe3748c4f --- /dev/null +++ b/docs/tr/1.6.x/api-pages.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.6.x

Translate

Pages and Styles

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

+

Provided Props

+

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

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.6.x/api-pages/index.html b/docs/tr/1.6.x/api-pages/index.html new file mode 100644 index 0000000000..cfe3748c4f --- /dev/null +++ b/docs/tr/1.6.x/api-pages/index.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.6.x

Translate

Pages and Styles

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

+

Provided Props

+

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

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.6.x/blog.html b/docs/tr/1.6.x/blog.html new file mode 100644 index 0000000000..5cd88d3555 --- /dev/null +++ b/docs/tr/1.6.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.6.x/blog/index.html b/docs/tr/1.6.x/blog/index.html new file mode 100644 index 0000000000..5cd88d3555 --- /dev/null +++ b/docs/tr/1.6.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.6.x/commands.html b/docs/tr/1.6.x/commands.html new file mode 100644 index 0000000000..28e0d1bf87 --- /dev/null +++ b/docs/tr/1.6.x/commands.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.6.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.6.x/commands/index.html b/docs/tr/1.6.x/commands/index.html new file mode 100644 index 0000000000..28e0d1bf87 --- /dev/null +++ b/docs/tr/1.6.x/commands/index.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.6.x

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.6.x/custom-pages.html b/docs/tr/1.6.x/custom-pages.html new file mode 100644 index 0000000000..906a43d6b9 --- /dev/null +++ b/docs/tr/1.6.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.6.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.6.x/custom-pages/index.html b/docs/tr/1.6.x/custom-pages/index.html new file mode 100644 index 0000000000..906a43d6b9 --- /dev/null +++ b/docs/tr/1.6.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.6.x

Translate

Custom Pages

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

+

Ana Sayfanız Özelleştiriliyor

+

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

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

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

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.6.x/doc-markdown.html b/docs/tr/1.6.x/doc-markdown.html new file mode 100644 index 0000000000..94baef2945 --- /dev/null +++ b/docs/tr/1.6.x/doc-markdown.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.6.x

Translate

Markdown Features

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

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.6.x/doc-markdown/index.html b/docs/tr/1.6.x/doc-markdown/index.html new file mode 100644 index 0000000000..94baef2945 --- /dev/null +++ b/docs/tr/1.6.x/doc-markdown/index.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.6.x

Translate

Markdown Features

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

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

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

+

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

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

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

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

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

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

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

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

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

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

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

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.6.x/docker.html b/docs/tr/1.6.x/docker.html new file mode 100644 index 0000000000..adc6fb4105 --- /dev/null +++ b/docs/tr/1.6.x/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.6.x

Translate

Docker

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

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.6.x/docker/index.html b/docs/tr/1.6.x/docker/index.html new file mode 100644 index 0000000000..adc6fb4105 --- /dev/null +++ b/docs/tr/1.6.x/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.6.x

Translate

Docker

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

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.6.x/installation.html b/docs/tr/1.6.x/installation.html new file mode 100644 index 0000000000..a820dfe30d --- /dev/null +++ b/docs/tr/1.6.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.6.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.6.x/installation/index.html b/docs/tr/1.6.x/installation/index.html new file mode 100644 index 0000000000..a820dfe30d --- /dev/null +++ b/docs/tr/1.6.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.6.x

Translate

Installation

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

+

Installing Docusaurus

+

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

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.6.x/navigation.html b/docs/tr/1.6.x/navigation.html new file mode 100644 index 0000000000..54a484dc0b --- /dev/null +++ b/docs/tr/1.6.x/navigation.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.6.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.6.x/navigation/index.html b/docs/tr/1.6.x/navigation/index.html new file mode 100644 index 0000000000..54a484dc0b --- /dev/null +++ b/docs/tr/1.6.x/navigation/index.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.6.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

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

+

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

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

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

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

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

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

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

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

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

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

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

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

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

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

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.6.x/publishing.html b/docs/tr/1.6.x/publishing.html new file mode 100644 index 0000000000..f7a727a6a3 --- /dev/null +++ b/docs/tr/1.6.x/publishing.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.6.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

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

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

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.6.x/publishing/index.html b/docs/tr/1.6.x/publishing/index.html new file mode 100644 index 0000000000..f7a727a6a3 --- /dev/null +++ b/docs/tr/1.6.x/publishing/index.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.6.x

Translate

Publishing your site

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

+

Building Static HTML Pages

+

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

+
yarn run build # or `npm run build`
+
+

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

+

Hosting Static HTML Pages

+

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

+
+

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

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

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

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

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.6.x/search.html b/docs/tr/1.6.x/search.html new file mode 100644 index 0000000000..d8b62ab570 --- /dev/null +++ b/docs/tr/1.6.x/search.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.6.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.6.x/search/index.html b/docs/tr/1.6.x/search/index.html new file mode 100644 index 0000000000..d8b62ab570 --- /dev/null +++ b/docs/tr/1.6.x/search/index.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.6.x

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Arama Çubuğunu Etkinleştirme

+

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

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.6.x/site-config.html b/docs/tr/1.6.x/site-config.html new file mode 100644 index 0000000000..aec2a08a6d --- /dev/null +++ b/docs/tr/1.6.x/site-config.html @@ -0,0 +1,386 @@ +siteConfig.js · Docusaurus

1.6.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

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

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

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

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.6.x/site-config/index.html b/docs/tr/1.6.x/site-config/index.html new file mode 100644 index 0000000000..aec2a08a6d --- /dev/null +++ b/docs/tr/1.6.x/site-config/index.html @@ -0,0 +1,386 @@ +siteConfig.js · Docusaurus

1.6.x

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

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

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

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

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

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

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.6.x/site-creation.html b/docs/tr/1.6.x/site-creation.html new file mode 100644 index 0000000000..1aea292bcb --- /dev/null +++ b/docs/tr/1.6.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.6.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.6.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.6.x/site-config), following the comments included in the [docs](/docs/tr/1.6.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.6.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.6.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.6.x/site-creation/index.html b/docs/tr/1.6.x/site-creation/index.html new file mode 100644 index 0000000000..1aea292bcb --- /dev/null +++ b/docs/tr/1.6.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.6.x

Translate

Creating your site

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

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.6.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.6.x/site-config), following the comments included in the [docs](/docs/tr/1.6.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.6.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.6.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.6.x/site-preparation.html b/docs/tr/1.6.x/site-preparation.html new file mode 100644 index 0000000000..9db5905e1d --- /dev/null +++ b/docs/tr/1.6.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.6.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.6.x/site-preparation/index.html b/docs/tr/1.6.x/site-preparation/index.html new file mode 100644 index 0000000000..9db5905e1d --- /dev/null +++ b/docs/tr/1.6.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.6.x

Translate

Site Preparation

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

+

Directory Structure

+

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

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.6.x/translation.html b/docs/tr/1.6.x/translation.html new file mode 100644 index 0000000000..f1a9a2e9b7 --- /dev/null +++ b/docs/tr/1.6.x/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.6.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.6.x/translation/index.html b/docs/tr/1.6.x/translation/index.html new file mode 100644 index 0000000000..f1a9a2e9b7 --- /dev/null +++ b/docs/tr/1.6.x/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.6.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

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

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

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

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

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

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.6.x/versioning.html b/docs/tr/1.6.x/versioning.html new file mode 100644 index 0000000000..58a4b7daa8 --- /dev/null +++ b/docs/tr/1.6.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.6.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.6.x/versioning/index.html b/docs/tr/1.6.x/versioning/index.html new file mode 100644 index 0000000000..58a4b7daa8 --- /dev/null +++ b/docs/tr/1.6.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.6.x

Translate

Versioning

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

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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

+

Mevcut Sürümleri Yeniden Adlandırma

+

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

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.7.3/adding-blog.html b/docs/tr/1.7.3/adding-blog.html new file mode 100644 index 0000000000..4157805ce7 --- /dev/null +++ b/docs/tr/1.7.3/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.7.3/adding-blog/index.html b/docs/tr/1.7.3/adding-blog/index.html new file mode 100644 index 0000000000..4157805ce7 --- /dev/null +++ b/docs/tr/1.7.3/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

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

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

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

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/1.7.3/api-pages.html b/docs/tr/1.7.3/api-pages.html new file mode 100644 index 0000000000..76ed7ae0d4 --- /dev/null +++ b/docs/tr/1.7.3/api-pages.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.7.3

Translate

Pages and Styles

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

+

Provided Props

+

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

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.7.3/api-pages/index.html b/docs/tr/1.7.3/api-pages/index.html new file mode 100644 index 0000000000..76ed7ae0d4 --- /dev/null +++ b/docs/tr/1.7.3/api-pages/index.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.7.3

Translate

Pages and Styles

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

+

Provided Props

+

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

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

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

CompLibrary.Container

+

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

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

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

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

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

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/1.7.3/blog.html b/docs/tr/1.7.3/blog.html new file mode 100644 index 0000000000..3fcab7bcb9 --- /dev/null +++ b/docs/tr/1.7.3/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

İlk Kurulum

+

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

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

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

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.7.3/blog/index.html b/docs/tr/1.7.3/blog/index.html new file mode 100644 index 0000000000..3fcab7bcb9 --- /dev/null +++ b/docs/tr/1.7.3/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

İlk Kurulum

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/1.7.3/commands.html b/docs/tr/1.7.3/commands.html new file mode 100644 index 0000000000..a19d755d8e --- /dev/null +++ b/docs/tr/1.7.3/commands.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.7.3

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.7.3/commands/index.html b/docs/tr/1.7.3/commands/index.html new file mode 100644 index 0000000000..a19d755d8e --- /dev/null +++ b/docs/tr/1.7.3/commands/index.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.7.3

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/1.7.3/custom-pages.html b/docs/tr/1.7.3/custom-pages.html new file mode 100644 index 0000000000..4108cd0661 --- /dev/null +++ b/docs/tr/1.7.3/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.7.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

Ana Sayfanız Özelleştiriliyor

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.7.3/custom-pages/index.html b/docs/tr/1.7.3/custom-pages/index.html new file mode 100644 index 0000000000..4108cd0661 --- /dev/null +++ b/docs/tr/1.7.3/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.7.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

Ana Sayfanız Özelleştiriliyor

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/1.7.3/doc-markdown.html b/docs/tr/1.7.3/doc-markdown.html new file mode 100644 index 0000000000..6002d60bee --- /dev/null +++ b/docs/tr/1.7.3/doc-markdown.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.7.3

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

+
![alt-text](assets/doc-image.png)
+
+

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.7.3/doc-markdown/index.html b/docs/tr/1.7.3/doc-markdown/index.html new file mode 100644 index 0000000000..6002d60bee --- /dev/null +++ b/docs/tr/1.7.3/doc-markdown/index.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.7.3

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

+
![alt-text](assets/doc-image.png)
+
+

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/1.7.3/docker.html b/docs/tr/1.7.3/docker.html new file mode 100644 index 0000000000..9bb411c66d --- /dev/null +++ b/docs/tr/1.7.3/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.7.3

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.7.3/docker/index.html b/docs/tr/1.7.3/docker/index.html new file mode 100644 index 0000000000..9bb411c66d --- /dev/null +++ b/docs/tr/1.7.3/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.7.3

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/1.7.3/installation.html b/docs/tr/1.7.3/installation.html new file mode 100644 index 0000000000..50456a40c6 --- /dev/null +++ b/docs/tr/1.7.3/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.7.3

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+

Installing Docusaurus

+

We have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.7.3/installation/index.html b/docs/tr/1.7.3/installation/index.html new file mode 100644 index 0000000000..50456a40c6 --- /dev/null +++ b/docs/tr/1.7.3/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.7.3

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+

Installing Docusaurus

+

We have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/1.7.3/navigation.html b/docs/tr/1.7.3/navigation.html new file mode 100644 index 0000000000..52a4dce75f --- /dev/null +++ b/docs/tr/1.7.3/navigation.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.7.3

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.7.3/navigation/index.html b/docs/tr/1.7.3/navigation/index.html new file mode 100644 index 0000000000..52a4dce75f --- /dev/null +++ b/docs/tr/1.7.3/navigation/index.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.7.3

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/1.7.3/publishing.html b/docs/tr/1.7.3/publishing.html new file mode 100644 index 0000000000..6805c99daa --- /dev/null +++ b/docs/tr/1.7.3/publishing.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.7.3

Translate

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+

Building Static HTML Pages

+

To create a static build of your website, run the following script from the website directory:

+
yarn run build # or `npm run build`
+
+

This will generate a build directory inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

Hosting Static HTML Pages

+

At this point, you can grab all of the files inside the website/build directory and copy them over to your favorite web server's html directory.

+
+

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.7.3/publishing/index.html b/docs/tr/1.7.3/publishing/index.html new file mode 100644 index 0000000000..6805c99daa --- /dev/null +++ b/docs/tr/1.7.3/publishing/index.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.7.3

Translate

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+

Building Static HTML Pages

+

To create a static build of your website, run the following script from the website directory:

+
yarn run build # or `npm run build`
+
+

This will generate a build directory inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

Hosting Static HTML Pages

+

At this point, you can grab all of the files inside the website/build directory and copy them over to your favorite web server's html directory.

+
+

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/1.7.3/search.html b/docs/tr/1.7.3/search.html new file mode 100644 index 0000000000..fc2fccb22a --- /dev/null +++ b/docs/tr/1.7.3/search.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.7.3

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

Arama Çubuğunu Etkinleştirme

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.7.3/search/index.html b/docs/tr/1.7.3/search/index.html new file mode 100644 index 0000000000..fc2fccb22a --- /dev/null +++ b/docs/tr/1.7.3/search/index.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.7.3

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

Arama Çubuğunu Etkinleştirme

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/1.7.3/site-config.html b/docs/tr/1.7.3/site-config.html new file mode 100644 index 0000000000..c757843a7a --- /dev/null +++ b/docs/tr/1.7.3/site-config.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.7.3

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.7.3/site-config/index.html b/docs/tr/1.7.3/site-config/index.html new file mode 100644 index 0000000000..c757843a7a --- /dev/null +++ b/docs/tr/1.7.3/site-config/index.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.7.3

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/1.7.3/site-creation.html b/docs/tr/1.7.3/site-creation.html new file mode 100644 index 0000000000..456769bff4 --- /dev/null +++ b/docs/tr/1.7.3/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.7.3

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.7.3/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.7.3/site-config), following the comments included in the [docs](/docs/tr/1.7.3/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.7.3/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.7.3/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.7.3/site-creation/index.html b/docs/tr/1.7.3/site-creation/index.html new file mode 100644 index 0000000000..456769bff4 --- /dev/null +++ b/docs/tr/1.7.3/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.7.3

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/1.7.3/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/1.7.3/site-config), following the comments included in the [docs](/docs/tr/1.7.3/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/1.7.3/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/1.7.3/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/1.7.3/site-preparation.html b/docs/tr/1.7.3/site-preparation.html new file mode 100644 index 0000000000..7768657917 --- /dev/null +++ b/docs/tr/1.7.3/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.7.3

Translate

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+

Directory Structure

+

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.7.3/site-preparation/index.html b/docs/tr/1.7.3/site-preparation/index.html new file mode 100644 index 0000000000..7768657917 --- /dev/null +++ b/docs/tr/1.7.3/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.7.3

Translate

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+

Directory Structure

+

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/1.7.3/translation.html b/docs/tr/1.7.3/translation.html new file mode 100644 index 0000000000..b4086d083a --- /dev/null +++ b/docs/tr/1.7.3/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.7.3

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.7.3/translation/index.html b/docs/tr/1.7.3/translation/index.html new file mode 100644 index 0000000000..b4086d083a --- /dev/null +++ b/docs/tr/1.7.3/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.7.3

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/1.7.3/versioning.html b/docs/tr/1.7.3/versioning.html new file mode 100644 index 0000000000..7884060099 --- /dev/null +++ b/docs/tr/1.7.3/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.7.3

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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.,

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/1.7.3/versioning/index.html b/docs/tr/1.7.3/versioning/index.html new file mode 100644 index 0000000000..7884060099 --- /dev/null +++ b/docs/tr/1.7.3/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.7.3

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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.,

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/adding-blog.html b/docs/tr/adding-blog.html new file mode 100644 index 0000000000..fcc700b5b8 --- /dev/null +++ b/docs/tr/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

İlk Kurulum

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/adding-blog/index.html b/docs/tr/adding-blog/index.html new file mode 100644 index 0000000000..fcc700b5b8 --- /dev/null +++ b/docs/tr/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

İlk Kurulum

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/api-pages.html b/docs/tr/api-pages.html new file mode 100644 index 0000000000..38c12831e3 --- /dev/null +++ b/docs/tr/api-pages.html @@ -0,0 +1,270 @@ +Pages and Styles · Docusaurus

1.8.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/api-pages/index.html b/docs/tr/api-pages/index.html new file mode 100644 index 0000000000..38c12831e3 --- /dev/null +++ b/docs/tr/api-pages/index.html @@ -0,0 +1,270 @@ +Pages and Styles · Docusaurus

1.8.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/blog.html b/docs/tr/blog.html new file mode 100644 index 0000000000..4acd5b8a68 --- /dev/null +++ b/docs/tr/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

İlk Kurulum

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/blog/index.html b/docs/tr/blog/index.html new file mode 100644 index 0000000000..4acd5b8a68 --- /dev/null +++ b/docs/tr/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

İlk Kurulum

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/tr/commands.html b/docs/tr/commands.html new file mode 100644 index 0000000000..5c4de98d57 --- /dev/null +++ b/docs/tr/commands.html @@ -0,0 +1,231 @@ +CLI Commands · Docusaurus

1.8.0

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
--skip-next-releasefalseSkip the next release documents when versioning is enabled. This will not build HTML files for documents in /docs directory.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/commands/index.html b/docs/tr/commands/index.html new file mode 100644 index 0000000000..5c4de98d57 --- /dev/null +++ b/docs/tr/commands/index.html @@ -0,0 +1,231 @@ +CLI Commands · Docusaurus

1.8.0

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
--skip-next-releasefalseSkip the next release documents when versioning is enabled. This will not build HTML files for documents in /docs directory.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/custom-pages.html b/docs/tr/custom-pages.html new file mode 100644 index 0000000000..df3f27d906 --- /dev/null +++ b/docs/tr/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.8.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

Ana Sayfanız Özelleştiriliyor

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/custom-pages/index.html b/docs/tr/custom-pages/index.html new file mode 100644 index 0000000000..df3f27d906 --- /dev/null +++ b/docs/tr/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.8.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

Ana Sayfanız Özelleştiriliyor

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/doc-markdown.html b/docs/tr/doc-markdown.html new file mode 100644 index 0000000000..ed6be19362 --- /dev/null +++ b/docs/tr/doc-markdown.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.8.0

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

+
![alt-text](assets/doc-image.png)
+
+

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/doc-markdown/index.html b/docs/tr/doc-markdown/index.html new file mode 100644 index 0000000000..ed6be19362 --- /dev/null +++ b/docs/tr/doc-markdown/index.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.8.0

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

+
![alt-text](assets/doc-image.png)
+
+

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/docker.html b/docs/tr/docker.html new file mode 100644 index 0000000000..c862f5c34c --- /dev/null +++ b/docs/tr/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.8.0

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/docker/index.html b/docs/tr/docker/index.html new file mode 100644 index 0000000000..c862f5c34c --- /dev/null +++ b/docs/tr/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.8.0

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/installation.html b/docs/tr/installation.html new file mode 100644 index 0000000000..bb094b9afd --- /dev/null +++ b/docs/tr/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.8.0

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+

Installing Docusaurus

+

We have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/installation/index.html b/docs/tr/installation/index.html new file mode 100644 index 0000000000..bb094b9afd --- /dev/null +++ b/docs/tr/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.8.0

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+

Installing Docusaurus

+

We have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/navigation.html b/docs/tr/navigation.html new file mode 100644 index 0000000000..2b8c2adf8e --- /dev/null +++ b/docs/tr/navigation.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.8.0

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/navigation/index.html b/docs/tr/navigation/index.html new file mode 100644 index 0000000000..2b8c2adf8e --- /dev/null +++ b/docs/tr/navigation/index.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.8.0

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/next/adding-blog.html b/docs/tr/next/adding-blog.html new file mode 100644 index 0000000000..c11c40c89a --- /dev/null +++ b/docs/tr/next/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

next

Translate

Adding a Blog

İlk Kurulum

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/next/adding-blog/index.html b/docs/tr/next/adding-blog/index.html new file mode 100644 index 0000000000..c11c40c89a --- /dev/null +++ b/docs/tr/next/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

next

Translate

Adding a Blog

İlk Kurulum

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

Daha sonra, siteConfig.js içine blog başlık bağlantısı ekleyin:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

Paylaşım Eklemek

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

Örnek olarak, website/blog/2017-08-18-Docusaurus-Tanıtımı.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

Başlık Seçenekleri

+

Tek gerekli alan title; dır fakat blog'unuza yazar bilgilerinizi eklemeniz için seçenekler sağlıyoruz.

+
    +
  • author - Yazar adının bulunduğu metin etiketi.
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

Özet Kesintisi

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate-->'in üstünde kalan herhangi bir şey özetin parçalı olacaktır. Örnek olarak:

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

Changing How Many Blog Posts Show on Sidebar

+

By default, 5 recent blog posts are shown on the sidebar.

+

You can configure a specific amount of blog posts to show by adding a blogSidebarCount setting to your siteConfig.js.

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

Örnek:

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

Örnek:

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

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 characters are used.

+

Social Buttons

+

If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the facebookAppId and/or twitter site configuration options in siteConfig.js.

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← DockerCustom Pages →
\ No newline at end of file diff --git a/docs/tr/next/api-pages.html b/docs/tr/next/api-pages.html new file mode 100644 index 0000000000..de80591a7d --- /dev/null +++ b/docs/tr/next/api-pages.html @@ -0,0 +1,270 @@ +Pages and Styles · Docusaurus

next

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/next/api-pages/index.html b/docs/tr/next/api-pages/index.html new file mode 100644 index 0000000000..de80591a7d --- /dev/null +++ b/docs/tr/next/api-pages/index.html @@ -0,0 +1,270 @@ +Pages and Styles · Docusaurus

next

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

Example

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/sayfalar/en içindeki dosyalarda aynı zamanda sayfalar'a kopyalanacaktır ve sayfalar içerisindeki aynı adlı dosyaların ÜZERİNE YAZILACAKTIR. 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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

Örnek:

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

Örnek:

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropTypeDefaultDescription
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

Example

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropTypeDefaultDescription
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyTypeDefaultDescription
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

Example

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown FeaturessiteConfig.js →
\ No newline at end of file diff --git a/docs/tr/next/commands.html b/docs/tr/next/commands.html new file mode 100644 index 0000000000..cc53e12e4a --- /dev/null +++ b/docs/tr/next/commands.html @@ -0,0 +1,231 @@ +CLI Commands · Docusaurus

next

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
--skip-next-releasefalseSkip the next release documents when versioning is enabled. This will not build HTML files for documents in /docs directory.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/next/commands/index.html b/docs/tr/next/commands/index.html new file mode 100644 index 0000000000..cc53e12e4a --- /dev/null +++ b/docs/tr/next/commands/index.html @@ -0,0 +1,231 @@ +CLI Commands · Docusaurus

next

Translate

CLI Commands

Docusaurus, üretmek, hizmet ve Web sitenizin dağıtmanıza yardımcı olacak komutlar kümesi sağlar. Bu komut dosyalarını run komutuyla Yarn veya npm kullanırken çağırabilir. Sık kullanılan bazı komutlar şunlardır:

+ +

Komut satırından çalıştırma

+

Yarn or npm kullanarak komut dosyalarını çalıştırabilirsiniz. Başlarken kılavuzunu zaten geçtiyseniz; zaten start </ code> komutunu biliyor olabilirsiniz. <code>docusaurus-start komutu Docusaurus'u çalıştırmasını başlatan komuttur. siteyi oluşturan ve bir sunucu başlatan komut dosyası ve genellikle böyle çağrılır:

+
yarn run start
+
+

Aynı komut npm dosyası kullanılarak çağrılabilir:

+
npm run start
+
+

Belirli bir komut dosyası çalıştırmak için, sadece komutunu, start yukarıdaki örneklerde komut dosyanızla ilişkili komutla birlikte kaydedin.

+

Argumentleri kullanmak

+

Bazı komutlar opsiyonel parametreleri destekler. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Eğer npm kullanarak Docusaurus çalıştrıyorsanız, komut satırına bağımsız değişkenler ekleyerek komut satırı değişkenlerini kullanmaya devam edebilirsiniz.`` arasındanpm run <command> ve komut argümanları:

+
npm run start -- --port 8080
+
+

Ayarlar

+

Bu komut dosyaları, "scripts" sizin şifreniz website/package.json dosyasını yükleme işleminin bir parçası olarak kullanın. Onları tekrar ayarlama konusunda yardıma ihtiyacınız varsa, Lütfen şunu seçiniz yükleme rehberi.

+

Docusaurus bazı varsayılan eşlemeleri düğümü kuralları aşağıdaki komutları çalıştırmanıza olanak sağlar. Yazarak yerine docusaurus-start every time, you can type yarn run start or npm start.

+

Komutlar

+ +
+

Referans

+

docusaurus-build

+

Eşdeğeri: build.

+ + + + + + + + +
OptionsDefaultDescription
--skip-image-compressionfalseSkip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
--skip-next-releasefalseSkip the next release documents when versioning is enabled. This will not build HTML files for documents in /docs directory.
+

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

+

See also docusaurus-start.

+
+

docusaurus-examples

+

Eşdeğeri: -c

+ + + + + + + +
ArgumentsDefaultDescription
<feature>-Specify a feature translations or versions to generate the extra example files for that feature.
+

Example

+
docusaurus-examples <feature>
+
+

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

+
+

docusaurus-publish

+

Alias: publish-gh-pages

+

Builds, then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:

+

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

+
    +
  • GIT_USER: Açılım işlemesi ile ilişkilendirilmiş git kullanıcısı.
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

Example

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: CI çalışmasını tetikleyen işleme ilişkili git branşı.
    • +
  • CI_PULL_REQUEST: Geçerli CI çalışması bir çekme isteğindeki bir işlem tarafından tetiklendiğinde doğruluğu beklenir.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
OptionsDefaultDescription
--port <number>3000The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
--watch-Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch.
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-version <version>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-write-translations

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← VersioningMarkdown Features →
\ No newline at end of file diff --git a/docs/tr/next/custom-pages.html b/docs/tr/next/custom-pages.html new file mode 100644 index 0000000000..deee8231c9 --- /dev/null +++ b/docs/tr/next/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

next

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

Ana Sayfanız Özelleştiriliyor

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/next/custom-pages/index.html b/docs/tr/next/custom-pages/index.html new file mode 100644 index 0000000000..deee8231c9 --- /dev/null +++ b/docs/tr/next/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

next

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

Ana Sayfanız Özelleştiriliyor

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. Oradan, website/pages/en/index.js dosyasını ve projeniz için istediğiniz görüntüleri ve metni kullanan değişken bileşenleri düzenleyin.

+

Diğer Özel Sayfalar Ekleniyor

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. Dahili bileşenler hakkında daha fazla bilgi ve kendi bileşenlerinizi nasıl ekleyeceğiniz hakkında bilgiyi burada bulabilirsiniz. Başlık gezinme çubuğunda farklı sayfalar için bağlantıyı nasıl ekleyeceğinizi burada bulabilirsiniz.

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

Statik Sayfalar Eklemek

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

Sitenizin Alt Bilgisini Özelleştirme

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

Sağlanan örnek solunda bir alt bilgi resmi ile birlikte üç sütun ve aşağısında Facebook'un açık kaynak logosu ve telif hakkına sahiptir. Projeniz bir Facebook açık kaynak projesi değilse, logoyu ve telif hakkını kaldırın. Aksi halde, alt bilginizle yaratıcı olun ve onun istediğiniz halde görünmesini sağlayın!

+

Sağlamak isteyebileceğiniz bağlantılar için bir kaç örnek: dokümantasyon, API, Twitter, Discord, Facebook grupları, Stack Overflow, GitHub, vs.

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← Adding a BlogEnabling Search →
\ No newline at end of file diff --git a/docs/tr/next/doc-markdown.html b/docs/tr/next/doc-markdown.html new file mode 100644 index 0000000000..292845a992 --- /dev/null +++ b/docs/tr/next/doc-markdown.html @@ -0,0 +1,246 @@ +Markdown Features · Docusaurus

next

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

+
![alt-text](assets/doc-image.png)
+
+

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/next/doc-markdown/index.html b/docs/tr/next/doc-markdown/index.html new file mode 100644 index 0000000000..292845a992 --- /dev/null +++ b/docs/tr/next/doc-markdown/index.html @@ -0,0 +1,246 @@ +Markdown Features · Docusaurus

next

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown Başlıkları

+

Döküman

+

Belgeler her iki tarafta bir çizgi --- ile kuşatılmış aşağıdaki markdown başlık alanlarını kullanır:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

Örnek olarak:

+
---
+id: dök1
+title: Benim Dokümanım
+sidebar_label: Doküman
+---
+
+

Kimliğe sahip sürümlenmiş dokümanlar kopyalanırken sürüm numaralarını içerecek şekilde değiştirilirler. O dokümanın versiyon numarası ${version} ve orijinal id'si ${id} olduğu yerde yeni id version-${version}-${id}'dir. Ek olarak, sürümlenen dokümanlara, orijinal doküman kimliğine sahip original_id alanı eklenir.

+

Örnek olarak:

+
---
+id: version-1.0.0-doc1
+title: Dokumanım
+sidebar_label: Doküman
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

Örnek olarak:

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

Blog Postları

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

title: Bu blog postunun başlığı.

+

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: Yazarım Facebook kimliği, sadece blog da gösterilmek için yazarın profil resmine erişim için kullanılıyor. Eğer bu alan ihmal edilmişse blog paylaşımında hiçbir yazar resmi gösterilmeyecektir.

+

Örnek olarak:

+
---
+title: İlk Blog Paylaşımım
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

Ekstra Özellikler

+

Docusaurus markdown ile doküman yazarken bir kaç ek özellik destekler.

+

Diğer Dokümanlara Bağlantılamak

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

Örnek:

+
[Bu diğer dokümanın bağlantısı](diger-dokuman.md)
+
+

Bu markdown işlendikten sonra otomatik olarak /docs/other-document.html(yada uygun olarak çevrilmiş/sürümlenmiş bağlantıya) bağlantısına dönüşür.

+

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.

+

Resimlere ve Diğer Varlıklara Bağlantılama

+

Static assets can be linked to in the same way that documents are, using relative URLs. Dokümanlar ve bloglar da kullanılan statik varlıklar sırasıyla docs/assets ve website/blog/assets içerisine gitmelidirler. Markdown doğru bağlantı yoluna çevrilecektir böylece bu yollar dokümanların tüm dilleri ve sürümleri için çalışacaktır.

+

Örnek:

+
![alt-text](assets/doc-image.png)
+
+

İçerik Panosu Üretme

+

You can make an auto-generated 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 ``. Dokümanınızı kod bloğu içerisindeki her fonksiyon için h3 başlığını kullanarak yazın. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Örnek:

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

bu fonksiyonun içerik panosuna yönlendirir:

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

ve her fonksiyon kendilerinin karşılık gelen sayfasına bağlanır.

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

Örnek:

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI CommandsPages and Styles →
\ No newline at end of file diff --git a/docs/tr/next/docker.html b/docs/tr/next/docker.html new file mode 100644 index 0000000000..67bff55e37 --- /dev/null +++ b/docs/tr/next/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

next

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/next/docker/index.html b/docs/tr/next/docker/index.html new file mode 100644 index 0000000000..67bff55e37 --- /dev/null +++ b/docs/tr/next/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

next

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← Publishing your siteAdding a Blog →
\ No newline at end of file diff --git a/docs/tr/next/installation.html b/docs/tr/next/installation.html new file mode 100644 index 0000000000..3a78852145 --- /dev/null +++ b/docs/tr/next/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

next

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+

Installing Docusaurus

+

We have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/next/installation/index.html b/docs/tr/next/installation/index.html new file mode 100644 index 0000000000..3a78852145 --- /dev/null +++ b/docs/tr/next/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

next

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

+

Installing Docusaurus

+

We have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    +
    +

    You have to be on Node >= 8.x and Yarn >= 1.5.

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs-examples-from-docusaurus and website.

    +
    +

    Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.

    +
    3. +

  3. Run the Docusaurus installation script: npx docusaurus-init.

    +
    +

    If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

    +
    4. +
+

Kurulumu doğrulama

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the example website

+

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

+
    +

  1. In your root, rename docs-examples-from-docusaurus to docs.

    2. +

  2. cd website

    3. +

  3. Rename blog-examples-from-docusaurus to blog.

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. Load the example site at http://localhost:3000 if it did not already open automatically.

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

Launching the server behind a proxy

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

If there is no noticeable version output from the outdated commands, then you are up-to-date.

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

yada

+
npm update docusaurus
+
+
+

If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g., yarn start) with the BABEL_DISABLE_CACHE=1 environment configuration.

+
+
Site Preparation →
\ No newline at end of file diff --git a/docs/tr/next/navigation.html b/docs/tr/next/navigation.html new file mode 100644 index 0000000000..0dfc603e9d --- /dev/null +++ b/docs/tr/next/navigation.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

next

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/next/navigation/index.html b/docs/tr/next/navigation/index.html new file mode 100644 index 0000000000..0dfc603e9d --- /dev/null +++ b/docs/tr/next/navigation/index.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

next

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Veya yan bar içinde yeni bir kategori oluşturabilirsiniz:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. Örneğin, website/pages/help.js içinde bir sayfamız varsa, aşağıdakileri ekleyerek ona bağlayabiliriz:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

Harici linkleri yeni bir sekmede açmak için, başlık link yapılandırması içinde bir external: true bayrağı sağlayın.

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

Sitenizde arama etkinleştirilmişse, arama barınız linklerinizin sağında görünür olacak. Linkler ve başlık arasına arama barı koymak isterseniz, headerLinks yapılandırma dizisine bir arama girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

Çeviriler sitenizde etkinleştirilmişse, dil açılır kutusu linklerinizin sağında görünür olacak (ve arama etkinse, arama barının solunda). Linkler ve başlık arasına dil seçimi açılır menüsü koymak isterseniz, headerLinks yapılandırma dizisine bir diller girdisi ekleyin:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← Enabling SearchTranslations & Localization →
\ No newline at end of file diff --git a/docs/tr/next/publishing.html b/docs/tr/next/publishing.html new file mode 100644 index 0000000000..43e5d07793 --- /dev/null +++ b/docs/tr/next/publishing.html @@ -0,0 +1,322 @@ +Publishing your site · Docusaurus

next

Translate

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+

Building Static HTML Pages

+

To create a static build of your website, run the following script from the website directory:

+
yarn run build # or `npm run build`
+
+

This will generate a build directory inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

Hosting Static HTML Pages

+

At this point, you can grab all of the files inside the website/build directory and copy them over to your favorite web server's html directory.

+
+

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/next/publishing/index.html b/docs/tr/next/publishing/index.html new file mode 100644 index 0000000000..43e5d07793 --- /dev/null +++ b/docs/tr/next/publishing/index.html @@ -0,0 +1,322 @@ +Publishing your site · Docusaurus

next

Translate

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+

Building Static HTML Pages

+

To create a static build of your website, run the following script from the website directory:

+
yarn run build # or `npm run build`
+
+

This will generate a build directory inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

Hosting Static HTML Pages

+

At this point, you can grab all of the files inside the website/build directory and copy them over to your favorite web server's html directory.

+
+

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/next/search.html b/docs/tr/next/search.html new file mode 100644 index 0000000000..ba9388955b --- /dev/null +++ b/docs/tr/next/search.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

next

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

Arama Çubuğunu Etkinleştirme

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/next/search/index.html b/docs/tr/next/search/index.html new file mode 100644 index 0000000000..ba9388955b --- /dev/null +++ b/docs/tr/next/search/index.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

next

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

Arama Çubuğunu Etkinleştirme

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/next/site-config.html b/docs/tr/next/site-config.html new file mode 100644 index 0000000000..a601f66ba4 --- /dev/null +++ b/docs/tr/next/site-config.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

next

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/next/site-config/index.html b/docs/tr/next/site-config/index.html new file mode 100644 index 0000000000..a601f66ba4 --- /dev/null +++ b/docs/tr/next/site-config/index.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

next

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/next/site-creation.html b/docs/tr/next/site-creation.html new file mode 100644 index 0000000000..b24233635b --- /dev/null +++ b/docs/tr/next/site-creation.html @@ -0,0 +1,179 @@ +Creating your site · Docusaurus

next

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.

    +
    ---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
    2. +

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. +
+
+

Eğer dosyalarınızı sidebars.json dosyasına eklemezseniz, dokümanlar işlenecektir ancak sadece diğer dokümanlara bağlantılanabilirler ve sadece URL biliniyorsa ziyaret edilebilirler.

+
+
    +
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. +
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. +
  3. Place assets, such as images, in the website/static/ directory.
    4. +
  4. Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
    5. +
+
cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/next/site-creation/index.html b/docs/tr/next/site-creation/index.html new file mode 100644 index 0000000000..b24233635b --- /dev/null +++ b/docs/tr/next/site-creation/index.html @@ -0,0 +1,179 @@ +Creating your site · Docusaurus

next

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +

  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.

    +
    ---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
    2. +

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. +
+
+

Eğer dosyalarınızı sidebars.json dosyasına eklemezseniz, dokümanlar işlenecektir ancak sadece diğer dokümanlara bağlantılanabilirler ve sadece URL biliniyorsa ziyaret edilebilirler.

+
+
    +
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. +
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. +
  3. Place assets, such as images, in the website/static/ directory.
    4. +
  4. Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
    5. +
+
cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/next/site-preparation.html b/docs/tr/next/site-preparation.html new file mode 100644 index 0000000000..75f3653ea5 --- /dev/null +++ b/docs/tr/next/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

next

Translate

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+

Directory Structure

+

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/next/site-preparation/index.html b/docs/tr/next/site-preparation/index.html new file mode 100644 index 0000000000..75f3653ea5 --- /dev/null +++ b/docs/tr/next/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

next

Translate

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+

Directory Structure

+

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/next/translation.html b/docs/tr/next/translation.html new file mode 100644 index 0000000000..da3ad40085 --- /dev/null +++ b/docs/tr/next/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

next

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/next/translation/index.html b/docs/tr/next/translation/index.html new file mode 100644 index 0000000000..da3ad40085 --- /dev/null +++ b/docs/tr/next/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

next

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/next/versioning.html b/docs/tr/next/versioning.html new file mode 100644 index 0000000000..be316cfb2b --- /dev/null +++ b/docs/tr/next/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

next

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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.,

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/next/versioning/index.html b/docs/tr/next/versioning/index.html new file mode 100644 index 0000000000..be316cfb2b --- /dev/null +++ b/docs/tr/next/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

next

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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.,

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/publishing.html b/docs/tr/publishing.html new file mode 100644 index 0000000000..4b0e0dc864 --- /dev/null +++ b/docs/tr/publishing.html @@ -0,0 +1,322 @@ +Publishing your site · Docusaurus

1.8.0

Translate

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+

Building Static HTML Pages

+

To create a static build of your website, run the following script from the website directory:

+
yarn run build # or `npm run build`
+
+

This will generate a build directory inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

Hosting Static HTML Pages

+

At this point, you can grab all of the files inside the website/build directory and copy them over to your favorite web server's html directory.

+
+

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/publishing/index.html b/docs/tr/publishing/index.html new file mode 100644 index 0000000000..4b0e0dc864 --- /dev/null +++ b/docs/tr/publishing/index.html @@ -0,0 +1,322 @@ +Publishing your site · Docusaurus

1.8.0

Translate

Publishing your site

You should now have a site up and running locally. Once you have customized it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution.

+

Building Static HTML Pages

+

To create a static build of your website, run the following script from the website directory:

+
yarn run build # or `npm run build`
+
+

This will generate a build directory inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

Hosting Static HTML Pages

+

At this point, you can grab all of the files inside the website/build directory and copy them over to your favorite web server's html directory.

+
+

For example, both Apache and nginx serve content from /var/www/html by default. That said, choosing a web server or provider is outside the scope of Docusaurus.

+

When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the content-type header of text/css. In the case of nginx, this would mean setting include /etc/nginx/mime.types; in your nginx.conf file. See this issue for more info.

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
NameDescription
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
NameDescription
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
NameDescription
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. Click Deploy site

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
NameDescription
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← Creating your siteDocker →
\ No newline at end of file diff --git a/docs/tr/search.html b/docs/tr/search.html new file mode 100644 index 0000000000..50481fe786 --- /dev/null +++ b/docs/tr/search.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.8.0

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

Arama Çubuğunu Etkinleştirme

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/search/index.html b/docs/tr/search/index.html new file mode 100644 index 0000000000..50481fe786 --- /dev/null +++ b/docs/tr/search/index.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.8.0

Translate

Enabling Search

Docusaurus Algolia DocSearch kullanarak aramayı destekler. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

Arama Çubuğunu Etkinleştirme

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← Custom PagesNavigation and Sidebars →
\ No newline at end of file diff --git a/docs/tr/site-config.html b/docs/tr/site-config.html new file mode 100644 index 0000000000..50d3ee8239 --- /dev/null +++ b/docs/tr/site-config.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.8.0

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/site-config/index.html b/docs/tr/site-config/index.html new file mode 100644 index 0000000000..50d3ee8239 --- /dev/null +++ b/docs/tr/site-config/index.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.8.0

Translate

siteConfig.js

Site yapılandırılmasının büyük bir bölümü siteConfig.js dosyasını düzenleyerek yapılıyor.

+

Kullanıcı Vitrini

+

users dizisi sitenizde göstermek istediğiniz her proje/kullanıcı için obje depolamak için kullanılır. Şu anda bu alan pages/en/index.js ve pages/en/users.js dosyalarının sağladığı örnekler için kullanılıyor. Her obje caption, image, infoLink ve pinned alanlarına sahip olmalıdır. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. pinned alanı sayfa indeks'inde gösterilip gösterilmeyeceğini belirler.

+

Şu anda bu kullanıcılar dizisi sadece index.js ve users.js örnek dosyaları tarafından kullanılıyor. Eğer kullanıcılar sayfasını istemiyorsanız yada kullanıcıları index sayfasında göstermek istemiyorsanız bu bölümü kaldırabilirsiniz.

+

siteConfig Alanları

+

siteConfig objesi web sitenizin yapılandırma ayarlarını toplu olarak barındırır.

+

Zorunlu Alanlar

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor başlık gezinme çubuğu ve yan çubuklarda kullanılan renk.
    • +
  • secondaryColor site penceresi daraltığında (mobil de dahil) başlık gezinme çubuğunun ikinci satırında gözüken renk.
    • +
  • Özelleştirilmiş renk yapılandırmaları da eklenebilir. Örnek olarak, eğer $myColor olarak tanımlanmış renklerle birlikte kullanıcı stilleri eklenirse myColor alanına colors eklemek bu rengin kolayca yapılandırılmasını sağlar.
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

Örnek Kullanım:

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

İsteğe Bağlı Alanlar

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← Pages and Styles
\ No newline at end of file diff --git a/docs/tr/site-creation.html b/docs/tr/site-creation.html new file mode 100644 index 0000000000..97982ce1d4 --- /dev/null +++ b/docs/tr/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.8.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/site-config), following the comments included in the [docs](/docs/tr/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/site-creation/index.html b/docs/tr/site-creation/index.html new file mode 100644 index 0000000000..97982ce1d4 --- /dev/null +++ b/docs/tr/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.8.0

Translate

Creating your site

Docusaurus was created to hopefully make it super simple for you to create a site and documentation for your open source project.

+

Kurulum ve hazırlıktan sonra dokümanlarınız için basit bir site oluşturma işinin çoğu tamamlanmış olur.

+

Site Yapısı

+

Your site structure looks like the following:

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

This assumes that you removed the example .md files that were installed with the initialization script.

+
+

All of your documentation files should be placed inside the docs directory as markdown .md files. Any blog posts should be inside the blog directory.

+
+

The blog posts must be formatted as YYYY-MM-DD-your-file-name.md

+
+

Temel Sitenizi Oluşturun

+

Tamamen fonksiyonel bir site oluşturmak için, sadece birkaç adımı yapmanız gerekir:

+
    +
  1. Add your documentation to the /docs directory as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/tr/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/tr/site-config), following the comments included in the [docs](/docs/tr/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/tr/custom-pages#customizing-your-site-footer) and/or [customize](/docs/tr/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Değişikliklerinizin sonuçlarını görmek için siteyi çalıştır.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← Site PreparationPublishing your site →
\ No newline at end of file diff --git a/docs/tr/site-preparation.html b/docs/tr/site-preparation.html new file mode 100644 index 0000000000..e09a516ff4 --- /dev/null +++ b/docs/tr/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.8.0

Translate

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+

Directory Structure

+

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/site-preparation/index.html b/docs/tr/site-preparation/index.html new file mode 100644 index 0000000000..e09a516ff4 --- /dev/null +++ b/docs/tr/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.8.0

Translate

Site Preparation

After installing Docusaurus, you now have a skeleton to work from for your specific website. The following discusses the rest of the Docusaurus structure in order for you to prepare your site.

+

Directory Structure

+

As shown after you installed Docusaurus, the initialization script created a directory structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus to website/blog) and document (docs-examples-from-docusaurus to docs) directories when you verified the installation.

+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs-examples-from-docusaurus directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • Pages: The website/pages directory contains example top-level pages for the site.
    • +
  • Static files and images: The website/static directory contains static assets used by the example site.
    • +
+

Key Files

+
    +
  • Footer: The website/core/Footer.js file is a React component that acts as the footer for the site generated by Docusaurus and should be customized by the user.
    • +
  • Configuration file: The website/siteConfig.js file is the main configuration file used by Docusaurus.
    • +
  • Sidebars: The sidebars.json file contains the structure and ordering of the documentation files.
    • +
+

Preparation Notes

+

website/siteConfig.js ve website/core/Footer.js dosyalarını sürdürmeniz gerekecek fakat onları istediğiniz gibi düzenleyebilirsiniz. The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. website/pages içerisinde en azından en/index.js yada en/index.html dosyasına ve website/static içerisinde başlık simgeniz olarak kullanılacak bir resme sahip olmalısınız.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/tr/translation.html b/docs/tr/translation.html new file mode 100644 index 0000000000..14c103a584 --- /dev/null +++ b/docs/tr/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.8.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/translation/index.html b/docs/tr/translation/index.html new file mode 100644 index 0000000000..14c103a584 --- /dev/null +++ b/docs/tr/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.8.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. İngilizce olarak yazılmış dokümantasyon dosyaları topluluk tarafından çevrilmesi için Crownd'ine yüklenir. İngilizce yazılmış üst seviye sayfalardaki istenilen dizeler <translate> etiketi ile sarılarak çevrilebilir. Diğer başlık ve etiketlerde bulunup uygunca çevrileceklerdir.

+

Docusaurus Tercüme Yapılandırmaları

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

yada

+
yarn examples translations
+
+

Bu aşağıdaki dosyaları oluşturacaktır:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js dosyası examples komutunun ürettiği aynı başlangıç yardım sayfasına sahiptir ama bu sefer tercüme etiketleri dahildir.
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

Mevcut Dosyalarınız Çevirme

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

Sayfalarda Tercümeyi Etkinleştirme

+

Sayfalar özelleştirilmiş indeks yada yardım sayfaları gibi belirli içerik sayfalarının yada yerleşim düzeninin özelleştirilmesine izin verir.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Çevirmek istediğiniz dizeleri <translate> etiketi ile sarın ve dosyanın başına gerekli ifadeyi ekleyin:

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

Aynı zamanda çevirmene dizeleri nasıl çevirmesi gerektiğini söyleyebileceğiniz isteğe bağlı açıklama da ekleyebilirsiniz:

+
<p>
+  <translate desc="çiçek, fiil değil">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

Çevrilecek Dizeleri Toplama

+

Sayfalar içinde bulunan dizeler ayrılmak ve Crowdin'e sağlanmak zorundadırlar.

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

Komutu çalıştırmak İngilizceden diğer dillere çevirilecek her dizeyi barındıran website/i18n/en.json dosyasını oluşturacaktır.

+

Komut aşağıdaki konumlardan metinler içerecektir:

+
    +
  • Dokümanın markdown başlıklarında içerisindeki title ve sidebar_label dizeleri
    • +
  • sidebars.json içerisindeki kategori isimleri
    • +
  • siteConfig.js içerisindeki sloganlar
    • +
  • siteConfig.js içerisindeki başlık bağlantı label dizeleri
    • +
  • pages içerisindeki herhangi bir .js dosyasındaki <translate> etiketi ile sarılmış dizeler
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

Dizeler Nasıl Tercüme Edilir

+

Docusaurus'un kendisi bir dilden başka bir dile çeviri yapmaz. Onun yerine, çevirilecekleri yüklemek ve düzgünce çevirilmişleri indirmek için Crowdin'le etkileşim içindedir.

+

Docusaurus Dize Tercümelerini Nasıl Kullanır

+

Bu bölüm Docusaurus'da tercümelerin nasıl çalıştığı hakkında içerik sağlar.

+

Dizerler

+

Bir Docusaurus sitesi yerelleştirme gerektiren bir çok dizeye sahiptir. Ancak çevirilecek dizelerin listesini tutmak zahmetli olabilir. Docusaurus simplifies this by centralizing strings.

+

Başlık gezintisi, örnek olarak 'Ana Sayfa' yada 'Blog' bağlantılarınıza sahip olabilir. Bu ve sayfalarda bulunan diğer başlık ve kenar çubuğu dizeleri, ayrıştırılmışlardır ve i18n/en.json içerisinde yerleştirilmişlerdir. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Daha sonra, İspanyolca sayfalar oluşturulur, Docusaurus dizelerin İngilizce sürümü ile karşılık gelen, yerelleştirilmiş dizelerin yerini değiştirir. (örn. İspanyolca etkinleştirilmiş sayfalarda 'Yardım' 'Ayuda' olacaktır).

+

Markdown Dosyaları

+

Dokümantasyon sayfalarının kendileri için, tercüme edilmiş dosyalar indirilecek ve daha sonra uygun yerleşim şablonuna göre işlenecekler.

+

Diğer Sayfalar

+

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. Daha sorunsuz bir tercüme için Crowdin'in rehberleri kullanabilirsiniz. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manüel Olarak Dosya Eşleştirme

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

crowdin komutu examples komutu ile üretilmiş crowdin.yaml dosyasını kullanır. Dosyaların nasıl yükleneceğini/indirileceğini yapılandırmak için proje dizininizin içerisine yerleştirilmelidir.

+

crowdin.yaml dosyasındaki CROWDIN_PROJECT_ID ve CROWDIN_API_KEY çevresel değişkenlerinin Crowdin projeniz için Daire içerisinde ayarlandığına dikkat edin. Crowdin proje ayarlarında bulunabilirler.

+

Şimdi, Daire web sitenizin kurulumu için öncelikli olarak otomatik şekilde çevirileri almanıza yardımcı olacak. Sağlanan crowdin.yaml dosyası dokümanları website/translated_docs/ içerisine kopyalayacak ve i18n/en.json dizelerinin tercüme edilmiş halini de i18n/${language}.json içerisine kopyalayacak.

+

Eğer sizde Crowdin'i makinenizde yerel olarak kullanmak istiyorsanız Crowdin CLI tool'u yükleyebilir ve circle.yaml dosyasındaki aynı kodu çalıştırabilirsiniz. Tek fark Daire çevresel değişkenlerine sahip olmayacağınız için project_identifier'i ve crowdin.yamldosyası içerisindeki api_key değeri ayarlamak zorundasınız.

+

Sürümlenmiş Tercümeler

+

Eğer sizde dokümanlarınız için tercüme ve sürümleme istiyorsanız crowdin.yaml'ın sonuna aşağıdaki bölümü ekleyin:

+
  -
+    source: '/website/versioned_docs/**/*.md'
+    translation: '/website/translated_docs/%locale%/**/%original_file_name%'
+    languages_mapping: *anchor
+
+

Çevrilmiş, sürümlenmiş dokümanlar website/translated_docs/${language}/${version}/ içerisine kopyalanacaklar.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/tr/versioning.html b/docs/tr/versioning.html new file mode 100644 index 0000000000..9c830cf07b --- /dev/null +++ b/docs/tr/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.8.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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.,

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/tr/versioning/index.html b/docs/tr/versioning/index.html new file mode 100644 index 0000000000..9c830cf07b --- /dev/null +++ b/docs/tr/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.8.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

Yeni Sürümler Nasıl Oluşturulur

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Sürümleme Modelleri

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Her Sürüm için Dosya Depolama

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Geri Çekme İşlevselliği

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.

+

Mevcut Sürümleri Yeniden Adlandırma

+

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.,

+
yarn run rename-version 1.0.0 1.0.1
+
+

Sürümleme ve Çeviriler

+

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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← Translations & LocalizationCLI Commands →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/api-pages.html b/docs/zh-CN/1.0.x/api-pages.html new file mode 100644 index 0000000000..b8ec68cd4d --- /dev/null +++ b/docs/zh-CN/1.0.x/api-pages.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.0.x

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

+

URLs for Pages

+

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

+

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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/api-pages/index.html b/docs/zh-CN/1.0.x/api-pages/index.html new file mode 100644 index 0000000000..b8ec68cd4d --- /dev/null +++ b/docs/zh-CN/1.0.x/api-pages/index.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.0.x

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

+

URLs for Pages

+

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

+

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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/blog.html b/docs/zh-CN/1.0.x/blog.html new file mode 100644 index 0000000000..98e98a1019 --- /dev/null +++ b/docs/zh-CN/1.0.x/blog.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.0.x

Translate

Adding a Blog

初始设置

+

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

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.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

+

例如：

+
blogSidebarCount: 'ALL'
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/blog/index.html b/docs/zh-CN/1.0.x/blog/index.html new file mode 100644 index 0000000000..98e98a1019 --- /dev/null +++ b/docs/zh-CN/1.0.x/blog/index.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.0.x

Translate

Adding a Blog

初始设置

+

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

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.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

+

例如：

+
blogSidebarCount: 'ALL'
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/commands.html b/docs/zh-CN/1.0.x/commands.html new file mode 100644 index 0000000000..4081319968 --- /dev/null +++ b/docs/zh-CN/1.0.x/commands.html @@ -0,0 +1,187 @@ +CLI Commands · Docusaurus

1.0.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

See also docusaurus-start.

+
+

docusaurus-examples [feature]

+

别名：examples

+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。 指定附加功能 translations 或 versions，以生成附加功能的额外文件。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +

  • GIT_USER：与部署相关的 GIT 用户。

    • +

  • 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
+
    • +
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version <currentVersion> <newVersion>

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+

See the Versioning guide to learn more.

+
+

docusaurus-start [--port <number>]

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/commands/index.html b/docs/zh-CN/1.0.x/commands/index.html new file mode 100644 index 0000000000..4081319968 --- /dev/null +++ b/docs/zh-CN/1.0.x/commands/index.html @@ -0,0 +1,187 @@ +CLI Commands · Docusaurus

1.0.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

See also docusaurus-start.

+
+

docusaurus-examples [feature]

+

别名：examples

+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。 指定附加功能 translations 或 versions，以生成附加功能的额外文件。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +

  • GIT_USER：与部署相关的 GIT 用户。

    • +

  • 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
+
    • +
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version <currentVersion> <newVersion>

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+

See the Versioning guide to learn more.

+
+

docusaurus-start [--port <number>]

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server. The website will be served from port 3000 by default.

+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/custom-pages.html b/docs/zh-CN/1.0.x/custom-pages.html new file mode 100644 index 0000000000..0cb7425fc6 --- /dev/null +++ b/docs/zh-CN/1.0.x/custom-pages.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.0.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 上一页启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/custom-pages/index.html b/docs/zh-CN/1.0.x/custom-pages/index.html new file mode 100644 index 0000000000..0cb7425fc6 --- /dev/null +++ b/docs/zh-CN/1.0.x/custom-pages/index.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.0.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 上一页启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/doc-markdown.html b/docs/zh-CN/1.0.x/doc-markdown.html new file mode 100644 index 0000000000..99f2908e40 --- /dev/null +++ b/docs/zh-CN/1.0.x/doc-markdown.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.0.x

Translate

Markdown Features

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

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.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

+

链接到图像和其它资源

+

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/doc-markdown/index.html b/docs/zh-CN/1.0.x/doc-markdown/index.html new file mode 100644 index 0000000000..99f2908e40 --- /dev/null +++ b/docs/zh-CN/1.0.x/doc-markdown/index.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.0.x

Translate

Markdown Features

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

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.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

+

链接到图像和其它资源

+

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/installation.html b/docs/zh-CN/1.0.x/installation.html new file mode 100644 index 0000000000..3e84a32eb6 --- /dev/null +++ b/docs/zh-CN/1.0.x/installation.html @@ -0,0 +1,147 @@ +Installation · Docusaurus

1.0.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    +
    2. +

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. +

  3. npx docusaurus-init

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-of-repo
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。
    2. +
  2. cd website
    3. +
  3. 把 blog-examples-from-docusaurus 重命名为 blog。
    4. +
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/installation/index.html b/docs/zh-CN/1.0.x/installation/index.html new file mode 100644 index 0000000000..3e84a32eb6 --- /dev/null +++ b/docs/zh-CN/1.0.x/installation/index.html @@ -0,0 +1,147 @@ +Installation · Docusaurus

1.0.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    +
    2. +

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. +

  3. npx docusaurus-init

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-of-repo
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。
    2. +
  2. cd website
    3. +
  3. 把 blog-examples-from-docusaurus 重命名为 blog。
    4. +
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/navigation.html b/docs/zh-CN/1.0.x/navigation.html new file mode 100644 index 0000000000..3d9c0ced04 --- /dev/null +++ b/docs/zh-CN/1.0.x/navigation.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.0.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/navigation/index.html b/docs/zh-CN/1.0.x/navigation/index.html new file mode 100644 index 0000000000..3d9c0ced04 --- /dev/null +++ b/docs/zh-CN/1.0.x/navigation/index.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.0.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/publishing.html b/docs/zh-CN/1.0.x/publishing.html new file mode 100644 index 0000000000..e234f83aa3 --- /dev/null +++ b/docs/zh-CN/1.0.x/publishing.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.0.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

构建静态 HTML 页

+

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only one circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:7.10
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← 创建你的站点下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/publishing/index.html b/docs/zh-CN/1.0.x/publishing/index.html new file mode 100644 index 0000000000..e234f83aa3 --- /dev/null +++ b/docs/zh-CN/1.0.x/publishing/index.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.0.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

构建静态 HTML 页

+

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://docusaurus.io (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only one circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:7.10
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← 创建你的站点下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/search.html b/docs/zh-CN/1.0.x/search.html new file mode 100644 index 0000000000..984f15f7c8 --- /dev/null +++ b/docs/zh-CN/1.0.x/search.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.0.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/search/index.html b/docs/zh-CN/1.0.x/search/index.html new file mode 100644 index 0000000000..984f15f7c8 --- /dev/null +++ b/docs/zh-CN/1.0.x/search/index.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.0.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/site-config.html b/docs/zh-CN/1.0.x/site-config.html new file mode 100644 index 0000000000..bf8cd6ae2e --- /dev/null +++ b/docs/zh-CN/1.0.x/site-config.html @@ -0,0 +1,279 @@ +siteConfig.js · Docusaurus

1.0.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - 网站图标的url。

+

headerIcon - 标题导航栏中使用的图标的 url。

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repo project name (case sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - url for your site.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs'
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    { doc: 'doc1', label: 'Docs' },
+    { page: 'help', label: 'Help' },
+    { search: true },
+    { blog: true }
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B'
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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' ],
+  stylesheets: [ 'https://docusaurus.io/style.css' ],
+  facebookAppId: '1615782811974223',
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/site-config/index.html b/docs/zh-CN/1.0.x/site-config/index.html new file mode 100644 index 0000000000..bf8cd6ae2e --- /dev/null +++ b/docs/zh-CN/1.0.x/site-config/index.html @@ -0,0 +1,279 @@ +siteConfig.js · Docusaurus

1.0.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - 网站图标的url。

+

headerIcon - 标题导航栏中使用的图标的 url。

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repo project name (case sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - url for your site.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs'
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons at the bottom of your blog posts, provide a Facebook application id, and the buttons will show up on all blog posts.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    { doc: 'doc1', label: 'Docs' },
+    { page: 'help', label: 'Help' },
+    { search: true },
+    { blog: true }
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B'
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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' ],
+  stylesheets: [ 'https://docusaurus.io/style.css' ],
+  facebookAppId: '1615782811974223',
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/site-creation.html b/docs/zh-CN/1.0.x/site-creation.html new file mode 100644 index 0000000000..6711dd765e --- /dev/null +++ b/docs/zh-CN/1.0.x/site-creation.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.0.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.0.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.0.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.0.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/zh-CN/1.0.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.0.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Run the site to see the results of your changes.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/site-creation/index.html b/docs/zh-CN/1.0.x/site-creation/index.html new file mode 100644 index 0000000000..6711dd765e --- /dev/null +++ b/docs/zh-CN/1.0.x/site-creation/index.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.0.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.0.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.0.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.0.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/zh-CN/1.0.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.0.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Run the site to see the results of your changes.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/site-preparation.html b/docs/zh-CN/1.0.x/site-preparation.html new file mode 100644 index 0000000000..30164edc16 --- /dev/null +++ b/docs/zh-CN/1.0.x/site-preparation.html @@ -0,0 +1,139 @@ +Site Preparation · Docusaurus

1.0.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-of-repo
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • +
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • +
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • +
  • website/pages文件夹中包含示例网站的顶层页面。
    • +
  • website/static 文件夹包含示例网站使用的静态资源。
    • +
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • +
+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

+

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/site-preparation/index.html b/docs/zh-CN/1.0.x/site-preparation/index.html new file mode 100644 index 0000000000..30164edc16 --- /dev/null +++ b/docs/zh-CN/1.0.x/site-preparation/index.html @@ -0,0 +1,139 @@ +Site Preparation · Docusaurus

1.0.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-of-repo
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+├── website
+│   ├── blog-examples-from-docusaurus
+│   │   ├── 2016-03-11-blog-post.md
+│   │   └── 2017-04-10-blog-post-two.md
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • +
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • +
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • +
  • website/pages文件夹中包含示例网站的顶层页面。
    • +
  • website/static 文件夹包含示例网站使用的静态资源。
    • +
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • +
+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

+

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/translation.html b/docs/zh-CN/1.0.x/translation.html new file mode 100644 index 0000000000..c747e9a629 --- /dev/null +++ b/docs/zh-CN/1.0.x/translation.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.0.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

需要翻译文本的网页应放在 website/pages/en 文件夹中。

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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"
+
+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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/translation/index.html b/docs/zh-CN/1.0.x/translation/index.html new file mode 100644 index 0000000000..c747e9a629 --- /dev/null +++ b/docs/zh-CN/1.0.x/translation/index.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.0.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

需要翻译文本的网页应放在 website/pages/en 文件夹中。

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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"
+
+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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/versioning.html b/docs/zh-CN/1.0.x/versioning.html new file mode 100644 index 0000000000..cc6a54c920 --- /dev/null +++ b/docs/zh-CN/1.0.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.0.x

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

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.

+

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.,

+
yarn 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.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.0.x/versioning/index.html b/docs/zh-CN/1.0.x/versioning/index.html new file mode 100644 index 0000000000..cc6a54c920 --- /dev/null +++ b/docs/zh-CN/1.0.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.0.x

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

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.

+

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.,

+
yarn 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.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/api-pages.html b/docs/zh-CN/1.1.x/api-pages.html new file mode 100644 index 0000000000..3e3d912219 --- /dev/null +++ b/docs/zh-CN/1.1.x/api-pages.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.1.x

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

+

URLs for Pages

+

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

+

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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/api-pages/index.html b/docs/zh-CN/1.1.x/api-pages/index.html new file mode 100644 index 0000000000..3e3d912219 --- /dev/null +++ b/docs/zh-CN/1.1.x/api-pages/index.html @@ -0,0 +1,221 @@ +Pages and Styles · Docusaurus

1.1.x

Translate

Pages and Styles

Docusaurus支持在website/pages文件夹内将页面编写为React组件，该文件夹将会和网站的其他部分共享相同的页眉，页脚和样式。

+

URLs for Pages

+

任何在website/pages文件夹中的.js文件都将会使用文件路径中"pages"之后的部分渲染成静态html。 website/pages/en中的文件也将会被复制到pages中并且会覆盖pages中的任何同名文件。 例如：website/pages/en/help.js中的页面可以通过${baseUrl}en/help.js或${baseUrl}help.js来访问，其中的 ${baseUrl}就是siteConfig.js 文件中设置的baseUrl字段。

+

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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' 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 accessed 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' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/blog.html b/docs/zh-CN/1.1.x/blog.html new file mode 100644 index 0000000000..9d9a92b6d9 --- /dev/null +++ b/docs/zh-CN/1.1.x/blog.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.1.x

Translate

Adding a Blog

初始设置

+

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

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.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

+

例如：

+
blogSidebarCount: 'ALL'
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/blog/index.html b/docs/zh-CN/1.1.x/blog/index.html new file mode 100644 index 0000000000..9d9a92b6d9 --- /dev/null +++ b/docs/zh-CN/1.1.x/blog/index.html @@ -0,0 +1,192 @@ +Adding a Blog · Docusaurus

1.1.x

Translate

Adding a Blog

初始设置

+

要设置你的网站博客，需在你的工程website目录下先创建一个blog目录。

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

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.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

在播客文章中使用 <!--truncate--> 标记，这样，在浏览全部已发布的文章时，就可以看到博客中各文章的摘要信息。 <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

可用的选项是一个整数或字符串'ALL'，表示您希望显示的文章数量。

+

例如：

+
blogSidebarCount: 'ALL'
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main folder. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/commands.html b/docs/zh-CN/1.1.x/commands.html new file mode 100644 index 0000000000..b033cc31e2 --- /dev/null +++ b/docs/zh-CN/1.1.x/commands.html @@ -0,0 +1,226 @@ +CLI Commands · Docusaurus

1.1.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +

  • GIT_USER：与部署相关的 GIT 用户。

    • +

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    +

    示例

    • +
+
 GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: The git branch associated with the commit that triggered the CI run.
    • +
  • CI_PULL_REQUEST: Expected to be truthy if the current CI run was triggered by a commit in a pull request.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/commands/index.html b/docs/zh-CN/1.1.x/commands/index.html new file mode 100644 index 0000000000..b033cc31e2 --- /dev/null +++ b/docs/zh-CN/1.1.x/commands/index.html @@ -0,0 +1,226 @@ +CLI Commands · Docusaurus

1.1.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +

  • GIT_USER：与部署相关的 GIT 用户。

    • +

  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

    +

    示例

    • +
+
 GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH: The git branch associated with the commit that triggered the CI run.
    • +
  • CI_PULL_REQUEST: Expected to be truthy if the current CI run was triggered by a commit in a pull request.
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
    • +
  • CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
ArgumentsDefaultDescription
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

Example

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned folder. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/custom-pages.html b/docs/zh-CN/1.1.x/custom-pages.html new file mode 100644 index 0000000000..103c1c1a26 --- /dev/null +++ b/docs/zh-CN/1.1.x/custom-pages.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.1.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 上一页启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/custom-pages/index.html b/docs/zh-CN/1.1.x/custom-pages/index.html new file mode 100644 index 0000000000..103c1c1a26 --- /dev/null +++ b/docs/zh-CN/1.1.x/custom-pages/index.html @@ -0,0 +1,151 @@ +Custom Pages · Docusaurus

1.1.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   │   ├── index.js
+│   │   ├── users.js
+│   │   └── help.js
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static folder in the same way as other static assets. 或者，它们也可以被放置在pages文件夹中，并以原本方式发送给客户端，而不会被React渲染。

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 上一页启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/doc-markdown.html b/docs/zh-CN/1.1.x/doc-markdown.html new file mode 100644 index 0000000000..6f70cea38e --- /dev/null +++ b/docs/zh-CN/1.1.x/doc-markdown.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.1.x

Translate

Markdown Features

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

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.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

+

链接到图像和其它资源

+

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/doc-markdown/index.html b/docs/zh-CN/1.1.x/doc-markdown/index.html new file mode 100644 index 0000000000..6f70cea38e --- /dev/null +++ b/docs/zh-CN/1.1.x/doc-markdown/index.html @@ -0,0 +1,219 @@ +Markdown Features · Docusaurus

1.1.x

Translate

Markdown Features

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

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.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

博客文章使用以下markdown字段, 它们由两边的行 --- 括起来:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

您可以使用相关urls 链接到其他文档文件, 这样它们将自动转换为相应的 html 链接。

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

这可以帮助您在 GitHub 上浏览文档, 因为这样的链接将会功能链接到其他文档 (但仍在 GitHub), 但文档在得到渲染时将具有正确的 html 链接。

+

链接到图像和其它资源

+

使用相关 url 可以以与文档相同的方式链接静态资源。 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

您可以制作一个自动生成的链接列表, 它可以作为 API 文档的目录使用。

+

In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(
+      <h1>Hello, world!</h1>,
+      document.getElementById('root')
+    );
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/installation.html b/docs/zh-CN/1.1.x/installation.html new file mode 100644 index 0000000000..6cc4fc2bd0 --- /dev/null +++ b/docs/zh-CN/1.1.x/installation.html @@ -0,0 +1,154 @@ +Installation · Docusaurus

1.1.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    +
    2. +

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. +

  3. npx docusaurus-init

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。
    2. +
  2. cd website
    3. +
  3. 把 blog-examples-from-docusaurus 重命名为 blog。
    4. +
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/installation/index.html b/docs/zh-CN/1.1.x/installation/index.html new file mode 100644 index 0000000000..6cc4fc2bd0 --- /dev/null +++ b/docs/zh-CN/1.1.x/installation/index.html @@ -0,0 +1,154 @@ +Installation · Docusaurus

1.1.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

    +
    2. +

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. +

  3. npx docusaurus-init

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus. You can update to the latest version of Docusaurus by typing yarn upgrade docusaurus --latest or npm update docusaurus.

+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。
    2. +
  2. cd website
    3. +
  3. 把 blog-examples-from-docusaurus 重命名为 blog。
    4. +
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.
    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/navigation.html b/docs/zh-CN/1.1.x/navigation.html new file mode 100644 index 0000000000..cadf407bab --- /dev/null +++ b/docs/zh-CN/1.1.x/navigation.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.1.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/navigation/index.html b/docs/zh-CN/1.1.x/navigation/index.html new file mode 100644 index 0000000000..cadf407bab --- /dev/null +++ b/docs/zh-CN/1.1.x/navigation/index.html @@ -0,0 +1,254 @@ +Navigation and Sidebars · Docusaurus

1.1.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs folder (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+
+

Docusaurus currently does not support documents in nested folders; only in a flat folder structure. We are looking into adding support for nested folders.

+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add clickable labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/publishing.html b/docs/zh-CN/1.1.x/publishing.html new file mode 100644 index 0000000000..abef60079f --- /dev/null +++ b/docs/zh-CN/1.1.x/publishing.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.1.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

构建静态 HTML 页

+

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← 创建你的站点下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/publishing/index.html b/docs/zh-CN/1.1.x/publishing/index.html new file mode 100644 index 0000000000..abef60079f --- /dev/null +++ b/docs/zh-CN/1.1.x/publishing/index.html @@ -0,0 +1,260 @@ +Publishing your site · Docusaurus

1.1.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

This will generate a build folder inside the website directory containing the .html files from all of your docs and other pages included in pages.

+

构建静态 HTML 页

+

At this point, you can grab all of the files inside the website/build folder and copy them over to your favorite web server's html directory.

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repo is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. These sites will be served from the master branch of the repo. So, you will want to have the Docusaurus infra, your docs, etc. in another branch (e.g., maybe call it source). To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". The publish script will automatically deploy your site to the root of the master branch to be served.

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit Github's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repo. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repo that contains the documentation, by checking Settings | Collaborators & teams in the repo.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repo access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub org/repo.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci folder and create a config.yml under that folder.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repo connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      -run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci folder inside your website/static folder.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repo, or only master branch commits.

+
← 创建你的站点下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/search.html b/docs/zh-CN/1.1.x/search.html new file mode 100644 index 0000000000..ee63f890d3 --- /dev/null +++ b/docs/zh-CN/1.1.x/search.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.1.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/search/index.html b/docs/zh-CN/1.1.x/search/index.html new file mode 100644 index 0000000000..ee63f890d3 --- /dev/null +++ b/docs/zh-CN/1.1.x/search/index.html @@ -0,0 +1,136 @@ +Enabling Search · Docusaurus

1.1.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/site-config.html b/docs/zh-CN/1.1.x/site-config.html new file mode 100644 index 0000000000..2c43489b08 --- /dev/null +++ b/docs/zh-CN/1.1.x/site-config.html @@ -0,0 +1,287 @@ +siteConfig.js · Docusaurus

1.1.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - 网站图标的url。

+

headerIcon - 标题导航栏中使用的图标的 url。

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repo project name (case sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - url for your site.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/site-config/index.html b/docs/zh-CN/1.1.x/site-config/index.html new file mode 100644 index 0000000000..2c43489b08 --- /dev/null +++ b/docs/zh-CN/1.1.x/site-config/index.html @@ -0,0 +1,287 @@ +siteConfig.js · Docusaurus

1.1.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - 网站图标的url。

+

headerIcon - 标题导航栏中使用的图标的 url。

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repo project name (case sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - url for your site.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

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: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family css configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Folders inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the url and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/site-creation.html b/docs/zh-CN/1.1.x/site-creation.html new file mode 100644 index 0000000000..ca2e8c7086 --- /dev/null +++ b/docs/zh-CN/1.1.x/site-creation.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.1.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.1.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.1.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.1.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/zh-CN/1.1.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.1.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Run the site to see the results of your changes.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/site-creation/index.html b/docs/zh-CN/1.1.x/site-creation/index.html new file mode 100644 index 0000000000..ca2e8c7086 --- /dev/null +++ b/docs/zh-CN/1.1.x/site-creation/index.html @@ -0,0 +1,181 @@ +Creating your site · Docusaurus

1.1.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-of-repo
+├── docs
+├── website
+│   ├── blog
+│   ├── core
+│   │   └── Footer.js
+│   ├── node_modules
+│   ├── package.json
+│   ├── pages
+│   ├── sidebars.json
+│   ├── siteConfig.js
+│   └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

All of your documentation files should be placed inside the docs folder as markdown .md files. Any blog posts should be inside the blog folder.

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. Add your documentation to the /docs folder as .md files, ensuring you have the proper header in each file. The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1. Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.1.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+  > If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3. Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.1.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.1.x/site-config) and the `website/siteConfig.js` to guide you.
+1. Create any [custom pages](/docs/zh-CN/1.1.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.1.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1. Place assets, such as images, in the `website/static/` folder.
+1. Run the site to see the results of your changes.  
+
+  ```bash
+  cd website
+  yarn run start # or `npm run start`
+  # Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static folder with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/site-preparation.html b/docs/zh-CN/1.1.x/site-preparation.html new file mode 100644 index 0000000000..f406983c36 --- /dev/null +++ b/docs/zh-CN/1.1.x/site-preparation.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.1.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • +
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • +
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • +
  • website/pages文件夹中包含示例网站的顶层页面。
    • +
  • website/static 文件夹包含示例网站使用的静态资源。
    • +
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • +
+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

+

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/site-preparation/index.html b/docs/zh-CN/1.1.x/site-preparation/index.html new file mode 100644 index 0000000000..f406983c36 --- /dev/null +++ b/docs/zh-CN/1.1.x/site-preparation/index.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.1.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • +
  • website/blog-examples-from-docusaurus文件夹中包含使用markdown写的博客示范文章。
    • +
  • docs-examples-from-docusaurus文件夹中包含使用markdown写的示范文档文件。
    • +
  • website/pages文件夹中包含示例网站的顶层页面。
    • +
  • website/static 文件夹包含示例网站使用的静态资源。
    • +
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • +
+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

+

你不能删除 website/pages 和 website/static 文件夹, 但可以按你的意愿改变里面的内容。 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/translation.html b/docs/zh-CN/1.1.x/translation.html new file mode 100644 index 0000000000..10356384b5 --- /dev/null +++ b/docs/zh-CN/1.1.x/translation.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.1.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

需要翻译文本的网页应放在 website/pages/en 文件夹中。

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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"
+
+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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/translation/index.html b/docs/zh-CN/1.1.x/translation/index.html new file mode 100644 index 0000000000..10356384b5 --- /dev/null +++ b/docs/zh-CN/1.1.x/translation/index.html @@ -0,0 +1,279 @@ +Translations & Localization · Docusaurus

1.1.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

需要翻译文本的网页应放在 website/pages/en 文件夹中。

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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"
+
+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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/versioning.html b/docs/zh-CN/1.1.x/versioning.html new file mode 100644 index 0000000000..69a75be13e --- /dev/null +++ b/docs/zh-CN/1.1.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.1.x

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

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.

+

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.,

+
yarn 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.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.1.x/versioning/index.html b/docs/zh-CN/1.1.x/versioning/index.html new file mode 100644 index 0000000000..69a75be13e --- /dev/null +++ b/docs/zh-CN/1.1.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.1.x

Translate

Versioning

可以使用 version 脚本，根据 docs 目录中的最新内容生成新的文档版本。 然后, 即使 docs 目录的文档继续更改, 这些特定文档集仍将被保留和访问。

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

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.

+

Documents in the docs folder will be considered part of version next and they are available, for example, at the url docs/next/doc1.html. Documents from the latest version use the url docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the url docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs folder and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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.,

+
yarn 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.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/api-pages.html b/docs/zh-CN/1.2.x/api-pages.html new file mode 100644 index 0000000000..2f1061d06d --- /dev/null +++ b/docs/zh-CN/1.2.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.2.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/api-pages/index.html b/docs/zh-CN/1.2.x/api-pages/index.html new file mode 100644 index 0000000000..2f1061d06d --- /dev/null +++ b/docs/zh-CN/1.2.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.2.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/blog.html b/docs/zh-CN/1.2.x/blog.html new file mode 100644 index 0000000000..d7a4f6affa --- /dev/null +++ b/docs/zh-CN/1.2.x/blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.2.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/blog/index.html b/docs/zh-CN/1.2.x/blog/index.html new file mode 100644 index 0000000000..d7a4f6affa --- /dev/null +++ b/docs/zh-CN/1.2.x/blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.2.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/commands.html b/docs/zh-CN/1.2.x/commands.html new file mode 100644 index 0000000000..30e715bb30 --- /dev/null +++ b/docs/zh-CN/1.2.x/commands.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.2.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/commands/index.html b/docs/zh-CN/1.2.x/commands/index.html new file mode 100644 index 0000000000..30e715bb30 --- /dev/null +++ b/docs/zh-CN/1.2.x/commands/index.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.2.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/custom-pages.html b/docs/zh-CN/1.2.x/custom-pages.html new file mode 100644 index 0000000000..05eee3e6d3 --- /dev/null +++ b/docs/zh-CN/1.2.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.2.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 上一页启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/custom-pages/index.html b/docs/zh-CN/1.2.x/custom-pages/index.html new file mode 100644 index 0000000000..05eee3e6d3 --- /dev/null +++ b/docs/zh-CN/1.2.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.2.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 上一页启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/doc-markdown.html b/docs/zh-CN/1.2.x/doc-markdown.html new file mode 100644 index 0000000000..1cd3df455c --- /dev/null +++ b/docs/zh-CN/1.2.x/doc-markdown.html @@ -0,0 +1,234 @@ +Markdown Features · Docusaurus

1.2.x

Translate

Markdown Features

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
* `docusaurus.function(a, b)`
+* `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/doc-markdown/index.html b/docs/zh-CN/1.2.x/doc-markdown/index.html new file mode 100644 index 0000000000..1cd3df455c --- /dev/null +++ b/docs/zh-CN/1.2.x/doc-markdown/index.html @@ -0,0 +1,234 @@ +Markdown Features · Docusaurus

1.2.x

Translate

Markdown Features

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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>. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
* `docusaurus.function(a, b)`
+* `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/installation.html b/docs/zh-CN/1.2.x/installation.html new file mode 100644 index 0000000000..36dabc55bc --- /dev/null +++ b/docs/zh-CN/1.2.x/installation.html @@ -0,0 +1,181 @@ +Installation · Docusaurus

1.2.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. +

  3. npx docusaurus-init

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。
    2. +
  2. cd website
    3. +
  3. 把 blog-examples-from-docusaurus 重命名为 blog。
    4. +
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/installation/index.html b/docs/zh-CN/1.2.x/installation/index.html new file mode 100644 index 0000000000..36dabc55bc --- /dev/null +++ b/docs/zh-CN/1.2.x/installation/index.html @@ -0,0 +1,181 @@ +Installation · Docusaurus

1.2.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

    3. +

  3. npx docusaurus-init

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

+
    +
  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。
    2. +
  2. cd website
    3. +
  3. 把 blog-examples-from-docusaurus 重命名为 blog。
    4. +
  4. 通过 yarn start 或 npm start 运行本地服务器。
    5. +
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.
    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/navigation.html b/docs/zh-CN/1.2.x/navigation.html new file mode 100644 index 0000000000..93950a05d1 --- /dev/null +++ b/docs/zh-CN/1.2.x/navigation.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.2.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/navigation/index.html b/docs/zh-CN/1.2.x/navigation/index.html new file mode 100644 index 0000000000..93950a05d1 --- /dev/null +++ b/docs/zh-CN/1.2.x/navigation/index.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.2.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/publishing.html b/docs/zh-CN/1.2.x/publishing.html new file mode 100644 index 0000000000..c506fad459 --- /dev/null +++ b/docs/zh-CN/1.2.x/publishing.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.2.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/publishing/index.html b/docs/zh-CN/1.2.x/publishing/index.html new file mode 100644 index 0000000000..c506fad459 --- /dev/null +++ b/docs/zh-CN/1.2.x/publishing/index.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.2.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点下一页 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/search.html b/docs/zh-CN/1.2.x/search.html new file mode 100644 index 0000000000..fa301b1ad5 --- /dev/null +++ b/docs/zh-CN/1.2.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.2.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/search/index.html b/docs/zh-CN/1.2.x/search/index.html new file mode 100644 index 0000000000..fa301b1ad5 --- /dev/null +++ b/docs/zh-CN/1.2.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.2.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "lang:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/site-config.html b/docs/zh-CN/1.2.x/site-config.html new file mode 100644 index 0000000000..406fbc8c21 --- /dev/null +++ b/docs/zh-CN/1.2.x/site-config.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.2.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - URL for site favicon.

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - URL for your website.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/site-config/index.html b/docs/zh-CN/1.2.x/site-config/index.html new file mode 100644 index 0000000000..406fbc8c21 --- /dev/null +++ b/docs/zh-CN/1.2.x/site-config/index.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.2.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - URL for site favicon.

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - URL for your website.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/site-creation.html b/docs/zh-CN/1.2.x/site-creation.html new file mode 100644 index 0000000000..7d0ef00349 --- /dev/null +++ b/docs/zh-CN/1.2.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.2.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.2.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.2.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.2.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.2.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.2.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/site-creation/index.html b/docs/zh-CN/1.2.x/site-creation/index.html new file mode 100644 index 0000000000..7d0ef00349 --- /dev/null +++ b/docs/zh-CN/1.2.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.2.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.2.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.2.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.2.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.2.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.2.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/site-preparation.html b/docs/zh-CN/1.2.x/site-preparation.html new file mode 100644 index 0000000000..6cd19a1a84 --- /dev/null +++ b/docs/zh-CN/1.2.x/site-preparation.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.2.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • +
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • +
  • The website/pages directory contains example top-level pages for the site.
    • +
  • The website/static directory contains static assets used by the example site.
    • +
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • +
+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/site-preparation/index.html b/docs/zh-CN/1.2.x/site-preparation/index.html new file mode 100644 index 0000000000..6cd19a1a84 --- /dev/null +++ b/docs/zh-CN/1.2.x/site-preparation/index.html @@ -0,0 +1,141 @@ +Site Preparation · Docusaurus

1.2.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

You may have already renamed the example blog (website/blog-examples-from-docusaurus) and document (docs-examples-from-docusaurus) directories when you verified the installation.

+
+
    +
  • website/core/Footer.js文件是一个React组件，它充当由Docusaurus生成站点的页脚，同时应由用户自己来定制。
    • +
  • The website/blog-examples-from-docusaurus directory contains examples of blog posts written in markdown.
    • +
  • The docs-examples-from-docusaurus directory contains example documentation files written in markdown.
    • +
  • The website/pages directory contains example top-level pages for the site.
    • +
  • The website/static directory contains static assets used by the example site.
    • +
  • website/siteConfig.js 文件是 Docusaurus 使用的主要配置文件。
    • +
+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。

+

You should keep the website/pages and website/static directories, but may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/translation.html b/docs/zh-CN/1.2.x/translation.html new file mode 100644 index 0000000000..25408feb4b --- /dev/null +++ b/docs/zh-CN/1.2.x/translation.html @@ -0,0 +1,305 @@ +Translations & Localization · Docusaurus

1.2.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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"
+
+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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/translation/index.html b/docs/zh-CN/1.2.x/translation/index.html new file mode 100644 index 0000000000..25408feb4b --- /dev/null +++ b/docs/zh-CN/1.2.x/translation/index.html @@ -0,0 +1,305 @@ +Translations & Localization · Docusaurus

1.2.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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"
+
+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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/versioning.html b/docs/zh-CN/1.2.x/versioning.html new file mode 100644 index 0000000000..acf5427a00 --- /dev/null +++ b/docs/zh-CN/1.2.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.2.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.2.x/versioning/index.html b/docs/zh-CN/1.2.x/versioning/index.html new file mode 100644 index 0000000000..acf5427a00 --- /dev/null +++ b/docs/zh-CN/1.2.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.2.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/adding-blog.html b/docs/zh-CN/1.3.x/adding-blog.html new file mode 100644 index 0000000000..75444b3875 --- /dev/null +++ b/docs/zh-CN/1.3.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/adding-blog/index.html b/docs/zh-CN/1.3.x/adding-blog/index.html new file mode 100644 index 0000000000..75444b3875 --- /dev/null +++ b/docs/zh-CN/1.3.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← 发布你的站点自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/api-pages.html b/docs/zh-CN/1.3.x/api-pages.html new file mode 100644 index 0000000000..9daeaf057f --- /dev/null +++ b/docs/zh-CN/1.3.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.3.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/api-pages/index.html b/docs/zh-CN/1.3.x/api-pages/index.html new file mode 100644 index 0000000000..9daeaf057f --- /dev/null +++ b/docs/zh-CN/1.3.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.3.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/blog.html b/docs/zh-CN/1.3.x/blog.html new file mode 100644 index 0000000000..bb102142db --- /dev/null +++ b/docs/zh-CN/1.3.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/blog/index.html b/docs/zh-CN/1.3.x/blog/index.html new file mode 100644 index 0000000000..bb102142db --- /dev/null +++ b/docs/zh-CN/1.3.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.3.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/commands.html b/docs/zh-CN/1.3.x/commands.html new file mode 100644 index 0000000000..56d90c5527 --- /dev/null +++ b/docs/zh-CN/1.3.x/commands.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.3.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/commands/index.html b/docs/zh-CN/1.3.x/commands/index.html new file mode 100644 index 0000000000..56d90c5527 --- /dev/null +++ b/docs/zh-CN/1.3.x/commands/index.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.3.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/custom-pages.html b/docs/zh-CN/1.3.x/custom-pages.html new file mode 100644 index 0000000000..35e293f4a2 --- /dev/null +++ b/docs/zh-CN/1.3.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.3.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/custom-pages/index.html b/docs/zh-CN/1.3.x/custom-pages/index.html new file mode 100644 index 0000000000..35e293f4a2 --- /dev/null +++ b/docs/zh-CN/1.3.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.3.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/doc-markdown.html b/docs/zh-CN/1.3.x/doc-markdown.html new file mode 100644 index 0000000000..e55efd443c --- /dev/null +++ b/docs/zh-CN/1.3.x/doc-markdown.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.3.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/doc-markdown/index.html b/docs/zh-CN/1.3.x/doc-markdown/index.html new file mode 100644 index 0000000000..e55efd443c --- /dev/null +++ b/docs/zh-CN/1.3.x/doc-markdown/index.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.3.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/installation.html b/docs/zh-CN/1.3.x/installation.html new file mode 100644 index 0000000000..3a76f7dd05 --- /dev/null +++ b/docs/zh-CN/1.3.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.3.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. 创建一个项目（如果不存在），并切换目录到此项目的根目录下。

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/installation/index.html b/docs/zh-CN/1.3.x/installation/index.html new file mode 100644 index 0000000000..3a76f7dd05 --- /dev/null +++ b/docs/zh-CN/1.3.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.3.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. 创建一个项目（如果不存在），并切换目录到此项目的根目录下。

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/navigation.html b/docs/zh-CN/1.3.x/navigation.html new file mode 100644 index 0000000000..76f109a241 --- /dev/null +++ b/docs/zh-CN/1.3.x/navigation.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.3.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/navigation/index.html b/docs/zh-CN/1.3.x/navigation/index.html new file mode 100644 index 0000000000..76f109a241 --- /dev/null +++ b/docs/zh-CN/1.3.x/navigation/index.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.3.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherit meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/publishing.html b/docs/zh-CN/1.3.x/publishing.html new file mode 100644 index 0000000000..c386b9bc61 --- /dev/null +++ b/docs/zh-CN/1.3.x/publishing.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.3.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/publishing/index.html b/docs/zh-CN/1.3.x/publishing/index.html new file mode 100644 index 0000000000..c386b9bc61 --- /dev/null +++ b/docs/zh-CN/1.3.x/publishing/index.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.3.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/search.html b/docs/zh-CN/1.3.x/search.html new file mode 100644 index 0000000000..8141c52aba --- /dev/null +++ b/docs/zh-CN/1.3.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.3.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/search/index.html b/docs/zh-CN/1.3.x/search/index.html new file mode 100644 index 0000000000..8141c52aba --- /dev/null +++ b/docs/zh-CN/1.3.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.3.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/site-config.html b/docs/zh-CN/1.3.x/site-config.html new file mode 100644 index 0000000000..079427f656 --- /dev/null +++ b/docs/zh-CN/1.3.x/site-config.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.3.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - URL for site favicon.

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - URL for your website.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/site-config/index.html b/docs/zh-CN/1.3.x/site-config/index.html new file mode 100644 index 0000000000..079427f656 --- /dev/null +++ b/docs/zh-CN/1.3.x/site-config/index.html @@ -0,0 +1,298 @@ +siteConfig.js · Docusaurus

1.3.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - URL for site favicon.

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - URL for your website.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The script tag will be inserted in the HTML head.

+

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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'],
+  stylesheets: ['https://docusaurus.io/style.css'],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/site-creation.html b/docs/zh-CN/1.3.x/site-creation.html new file mode 100644 index 0000000000..0e6a5e8b89 --- /dev/null +++ b/docs/zh-CN/1.3.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.3.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.3.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.3.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.3.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.3.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.3.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/site-creation/index.html b/docs/zh-CN/1.3.x/site-creation/index.html new file mode 100644 index 0000000000..0e6a5e8b89 --- /dev/null +++ b/docs/zh-CN/1.3.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.3.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.3.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.3.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.3.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.3.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.3.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/site-preparation.html b/docs/zh-CN/1.3.x/site-preparation.html new file mode 100644 index 0000000000..af1b40217a --- /dev/null +++ b/docs/zh-CN/1.3.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.3.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 与 website/core/Footer.js 文件，但可以根据需要编辑它们。

+

您不能删除 website/pages 与 website/static 文件夹，但可以根据需要更改其中内容。 在 website/pages 文件夹内您至少应该有一个 en/index.js 或 en/index.html 文件，在 website/static 文件夹内至少应该有一个页头图标文件。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/site-preparation/index.html b/docs/zh-CN/1.3.x/site-preparation/index.html new file mode 100644 index 0000000000..af1b40217a --- /dev/null +++ b/docs/zh-CN/1.3.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.3.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 与 website/core/Footer.js 文件，但可以根据需要编辑它们。

+

您不能删除 website/pages 与 website/static 文件夹，但可以根据需要更改其中内容。 在 website/pages 文件夹内您至少应该有一个 en/index.js 或 en/index.html 文件，在 website/static 文件夹内至少应该有一个页头图标文件。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/translation.html b/docs/zh-CN/1.3.x/translation.html new file mode 100644 index 0000000000..b450fbd4a9 --- /dev/null +++ b/docs/zh-CN/1.3.x/translation.html @@ -0,0 +1,319 @@ +Translations & Localization · Docusaurus

1.3.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/translation/index.html b/docs/zh-CN/1.3.x/translation/index.html new file mode 100644 index 0000000000..b450fbd4a9 --- /dev/null +++ b/docs/zh-CN/1.3.x/translation/index.html @@ -0,0 +1,319 @@ +Translations & Localization · Docusaurus

1.3.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "id": "string",
+    "id2": "string2"
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/versioning.html b/docs/zh-CN/1.3.x/versioning.html new file mode 100644 index 0000000000..28b42d2a53 --- /dev/null +++ b/docs/zh-CN/1.3.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.3.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.3.x/versioning/index.html b/docs/zh-CN/1.3.x/versioning/index.html new file mode 100644 index 0000000000..28b42d2a53 --- /dev/null +++ b/docs/zh-CN/1.3.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.3.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/adding-blog.html b/docs/zh-CN/1.4.x/adding-blog.html new file mode 100644 index 0000000000..d220e02297 --- /dev/null +++ b/docs/zh-CN/1.4.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/adding-blog/index.html b/docs/zh-CN/1.4.x/adding-blog/index.html new file mode 100644 index 0000000000..d220e02297 --- /dev/null +++ b/docs/zh-CN/1.4.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/api-pages.html b/docs/zh-CN/1.4.x/api-pages.html new file mode 100644 index 0000000000..a50472c437 --- /dev/null +++ b/docs/zh-CN/1.4.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.4.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/api-pages/index.html b/docs/zh-CN/1.4.x/api-pages/index.html new file mode 100644 index 0000000000..a50472c437 --- /dev/null +++ b/docs/zh-CN/1.4.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.4.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/blog.html b/docs/zh-CN/1.4.x/blog.html new file mode 100644 index 0000000000..48197fa023 --- /dev/null +++ b/docs/zh-CN/1.4.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/blog/index.html b/docs/zh-CN/1.4.x/blog/index.html new file mode 100644 index 0000000000..48197fa023 --- /dev/null +++ b/docs/zh-CN/1.4.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.4.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/commands.html b/docs/zh-CN/1.4.x/commands.html new file mode 100644 index 0000000000..eb2386a042 --- /dev/null +++ b/docs/zh-CN/1.4.x/commands.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.4.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/commands/index.html b/docs/zh-CN/1.4.x/commands/index.html new file mode 100644 index 0000000000..eb2386a042 --- /dev/null +++ b/docs/zh-CN/1.4.x/commands/index.html @@ -0,0 +1,227 @@ +CLI Commands · Docusaurus

1.4.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This script will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/custom-pages.html b/docs/zh-CN/1.4.x/custom-pages.html new file mode 100644 index 0000000000..40ffaaabfd --- /dev/null +++ b/docs/zh-CN/1.4.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.4.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/custom-pages/index.html b/docs/zh-CN/1.4.x/custom-pages/index.html new file mode 100644 index 0000000000..40ffaaabfd --- /dev/null +++ b/docs/zh-CN/1.4.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.4.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/doc-markdown.html b/docs/zh-CN/1.4.x/doc-markdown.html new file mode 100644 index 0000000000..4f0115cf1b --- /dev/null +++ b/docs/zh-CN/1.4.x/doc-markdown.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.4.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/doc-markdown/index.html b/docs/zh-CN/1.4.x/doc-markdown/index.html new file mode 100644 index 0000000000..4f0115cf1b --- /dev/null +++ b/docs/zh-CN/1.4.x/doc-markdown/index.html @@ -0,0 +1,235 @@ +Markdown Features · Docusaurus

1.4.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/docker.html b/docs/zh-CN/1.4.x/docker.html new file mode 100644 index 0000000000..747899750c --- /dev/null +++ b/docs/zh-CN/1.4.x/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.4.x

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/docker/index.html b/docs/zh-CN/1.4.x/docker/index.html new file mode 100644 index 0000000000..747899750c --- /dev/null +++ b/docs/zh-CN/1.4.x/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.4.x

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/installation.html b/docs/zh-CN/1.4.x/installation.html new file mode 100644 index 0000000000..254d60681c --- /dev/null +++ b/docs/zh-CN/1.4.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.4.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. 创建一个项目（如果不存在），并切换目录到此项目的根目录下。

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/installation/index.html b/docs/zh-CN/1.4.x/installation/index.html new file mode 100644 index 0000000000..254d60681c --- /dev/null +++ b/docs/zh-CN/1.4.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.4.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. 创建一个项目（如果不存在），并切换目录到此项目的根目录下。

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/navigation.html b/docs/zh-CN/1.4.x/navigation.html new file mode 100644 index 0000000000..b063cf7dcb --- /dev/null +++ b/docs/zh-CN/1.4.x/navigation.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.4.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/navigation/index.html b/docs/zh-CN/1.4.x/navigation/index.html new file mode 100644 index 0000000000..b063cf7dcb --- /dev/null +++ b/docs/zh-CN/1.4.x/navigation/index.html @@ -0,0 +1,267 @@ +Navigation and Sidebars · Docusaurus

1.4.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/publishing.html b/docs/zh-CN/1.4.x/publishing.html new file mode 100644 index 0000000000..43fc23c2b6 --- /dev/null +++ b/docs/zh-CN/1.4.x/publishing.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.4.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/publishing/index.html b/docs/zh-CN/1.4.x/publishing/index.html new file mode 100644 index 0000000000..43fc23c2b6 --- /dev/null +++ b/docs/zh-CN/1.4.x/publishing/index.html @@ -0,0 +1,295 @@ +Publishing your site · Docusaurus

1.4.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

While choosing a web server or host is outside Docusaurus' scope, Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying your Docusaurus site to GitHub Pages is straightforward if you are already using GitHub to host your project. Your code repository does not even need to be public.

+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Most of the work to publish to GitHub pages is done for you automatically through the publish-gh-pages script. You just need to determine the values for a few parameters required by the script.

+

Two of the required parameters are set in the siteConfig.js:

+ + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
+
+

Docusaurus also supports deploying user or organization sites. To do this, just set projectName to "username.github.io" (where username is your username or organization name on GitHub) and organizationName to "username". For user or org sites, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separated repo (e.g. in the same as the documented source code).

+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+

One of the required parameters is set as a environment variable:

+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username.
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

Once you have the parameter value information, you can go ahead and run the publish script, ensuring you have inserted your own values inside the various parameter placeholders:

+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
+

The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.

+
+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (it can also be accessed via https://docusaurus.io/), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/search.html b/docs/zh-CN/1.4.x/search.html new file mode 100644 index 0000000000..f1f02523e9 --- /dev/null +++ b/docs/zh-CN/1.4.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.4.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/search/index.html b/docs/zh-CN/1.4.x/search/index.html new file mode 100644 index 0000000000..f1f02523e9 --- /dev/null +++ b/docs/zh-CN/1.4.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.4.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/site-config.html b/docs/zh-CN/1.4.x/site-config.html new file mode 100644 index 0000000000..f7c9f2d7da --- /dev/null +++ b/docs/zh-CN/1.4.x/site-config.html @@ -0,0 +1,312 @@ +siteConfig.js · Docusaurus

1.4.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - URL for site favicon.

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - URL for your website.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

enableUpdateTime - An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last Updated: dd/mm/yyyy hh:MM:ss Z.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

manifest - Path to your web app manifest (e.g., /manifest.json). This will add a <link> tag to <head> with rel as "manifest" and content as the provided path.

+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src: 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true
+    }
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: "text/css"
+    }
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/site-config/index.html b/docs/zh-CN/1.4.x/site-config/index.html new file mode 100644 index 0000000000..f7c9f2d7da --- /dev/null +++ b/docs/zh-CN/1.4.x/site-config/index.html @@ -0,0 +1,312 @@ +siteConfig.js · Docusaurus

1.4.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl - 网站的baseUrl。 For example, /pages/org/project/ is the baseUrl of https://git.facebook.com/pages/org/project/

+

colors - 网站的颜色。

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright - 网站页脚和信息流中的版权声明。

+

favicon - URL for site favicon.

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex - 真值。 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName - GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName - Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline - 网站标语。

+

title - 网站标题。

+

url - URL for your website.

+

可选属性

+

algolia - Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount - Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle - Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl - If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname - The CNAME for your website. It will go into a CNAME file when your site is 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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown - The default version for the site to be shown. If this is not set, the latest version will be shown.

+

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.

+

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.

+

enableUpdateTime - An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last Updated: dd/mm/yyyy hh:MM:ss Z.

+

facebookAppId - If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments - Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId - Facebook Pixel ID to track page views.

+

fonts - Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

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.

+

gaTrackingId - Google Analytics tracking ID to track page views.

+

gaGtag - Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost - Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight - Syntax highlighting options:

+
    +
  • theme is the name of the theme used by Highlight.js when highlighting code. You can find the list of supported themes here.
    • +
  • 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.
    • +
  • defaultLang defines a default language. It will be used if one is not specified at the top of the code block. You can find the list of supported languages here.
    • +
  • themeUrl is the custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the theme and version fields will be ignored.
    • +
+

manifest - Path to your web app manifest (e.g., /manifest.json). This will add a <link> tag to <head> with rel as "manifest" and content as the provided path.

+

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.

+

ogImage - Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav - If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts - Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop - Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions - Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets - Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

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.

+

twitter - Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername - If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage - Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl - If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users - The users array mentioned earlier.

+

usePrism - Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML - Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src: 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true
+    }
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: "text/css"
+    }
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/site-creation.html b/docs/zh-CN/1.4.x/site-creation.html new file mode 100644 index 0000000000..be1be463b1 --- /dev/null +++ b/docs/zh-CN/1.4.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.4.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.4.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.4.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.4.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.4.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.4.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/site-creation/index.html b/docs/zh-CN/1.4.x/site-creation/index.html new file mode 100644 index 0000000000..be1be463b1 --- /dev/null +++ b/docs/zh-CN/1.4.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.4.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title, is, of course, the title of the browser page.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.4.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.4.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.4.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.4.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.4.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/site-preparation.html b/docs/zh-CN/1.4.x/site-preparation.html new file mode 100644 index 0000000000..65dde60cf0 --- /dev/null +++ b/docs/zh-CN/1.4.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.4.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 与 website/core/Footer.js 文件，但可以根据需要编辑它们。

+

您不能删除 website/pages 与 website/static 文件夹，但可以根据需要更改其中内容。 在 website/pages 文件夹内您至少应该有一个 en/index.js 或 en/index.html 文件，在 website/static 文件夹内至少应该有一个页头图标文件。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/site-preparation/index.html b/docs/zh-CN/1.4.x/site-preparation/index.html new file mode 100644 index 0000000000..65dde60cf0 --- /dev/null +++ b/docs/zh-CN/1.4.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.4.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 与 website/core/Footer.js 文件，但可以根据需要编辑它们。

+

您不能删除 website/pages 与 website/static 文件夹，但可以根据需要更改其中内容。 在 website/pages 文件夹内您至少应该有一个 en/index.js 或 en/index.html 文件，在 website/static 文件夹内至少应该有一个页头图标文件。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/translation.html b/docs/zh-CN/1.4.x/translation.html new file mode 100644 index 0000000000..aa836ab4fa --- /dev/null +++ b/docs/zh-CN/1.4.x/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.4.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/translation/index.html b/docs/zh-CN/1.4.x/translation/index.html new file mode 100644 index 0000000000..aa836ab4fa --- /dev/null +++ b/docs/zh-CN/1.4.x/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.4.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/versioning.html b/docs/zh-CN/1.4.x/versioning.html new file mode 100644 index 0000000000..cbe115ea0c --- /dev/null +++ b/docs/zh-CN/1.4.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.4.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.4.x/versioning/index.html b/docs/zh-CN/1.4.x/versioning/index.html new file mode 100644 index 0000000000..cbe115ea0c --- /dev/null +++ b/docs/zh-CN/1.4.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.4.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/adding-blog.html b/docs/zh-CN/1.5.x/adding-blog.html new file mode 100644 index 0000000000..1e21bde3ec --- /dev/null +++ b/docs/zh-CN/1.5.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/adding-blog/index.html b/docs/zh-CN/1.5.x/adding-blog/index.html new file mode 100644 index 0000000000..1e21bde3ec --- /dev/null +++ b/docs/zh-CN/1.5.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/api-pages.html b/docs/zh-CN/1.5.x/api-pages.html new file mode 100644 index 0000000000..b6ddd405ab --- /dev/null +++ b/docs/zh-CN/1.5.x/api-pages.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.5.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/api-pages/index.html b/docs/zh-CN/1.5.x/api-pages/index.html new file mode 100644 index 0000000000..b6ddd405ab --- /dev/null +++ b/docs/zh-CN/1.5.x/api-pages/index.html @@ -0,0 +1,255 @@ +Pages and Styles · Docusaurus

1.5.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}docs/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/blog.html b/docs/zh-CN/1.5.x/blog.html new file mode 100644 index 0000000000..5efbdf075b --- /dev/null +++ b/docs/zh-CN/1.5.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/blog/index.html b/docs/zh-CN/1.5.x/blog/index.html new file mode 100644 index 0000000000..5efbdf075b --- /dev/null +++ b/docs/zh-CN/1.5.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.5.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/commands.html b/docs/zh-CN/1.5.x/commands.html new file mode 100644 index 0000000000..a434152990 --- /dev/null +++ b/docs/zh-CN/1.5.x/commands.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.5.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/commands/index.html b/docs/zh-CN/1.5.x/commands/index.html new file mode 100644 index 0000000000..a434152990 --- /dev/null +++ b/docs/zh-CN/1.5.x/commands/index.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.5.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/custom-pages.html b/docs/zh-CN/1.5.x/custom-pages.html new file mode 100644 index 0000000000..f14cc437bf --- /dev/null +++ b/docs/zh-CN/1.5.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.5.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/custom-pages/index.html b/docs/zh-CN/1.5.x/custom-pages/index.html new file mode 100644 index 0000000000..f14cc437bf --- /dev/null +++ b/docs/zh-CN/1.5.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.5.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/doc-markdown.html b/docs/zh-CN/1.5.x/doc-markdown.html new file mode 100644 index 0000000000..4d7fc48d3a --- /dev/null +++ b/docs/zh-CN/1.5.x/doc-markdown.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.5.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/doc-markdown/index.html b/docs/zh-CN/1.5.x/doc-markdown/index.html new file mode 100644 index 0000000000..4d7fc48d3a --- /dev/null +++ b/docs/zh-CN/1.5.x/doc-markdown/index.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.5.x

Translate

Markdown Features

Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

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.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/docker.html b/docs/zh-CN/1.5.x/docker.html new file mode 100644 index 0000000000..7041c84539 --- /dev/null +++ b/docs/zh-CN/1.5.x/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.5.x

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/docker/index.html b/docs/zh-CN/1.5.x/docker/index.html new file mode 100644 index 0000000000..7041c84539 --- /dev/null +++ b/docs/zh-CN/1.5.x/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.5.x

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/installation.html b/docs/zh-CN/1.5.x/installation.html new file mode 100644 index 0000000000..654809164e --- /dev/null +++ b/docs/zh-CN/1.5.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.5.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/installation/index.html b/docs/zh-CN/1.5.x/installation/index.html new file mode 100644 index 0000000000..654809164e --- /dev/null +++ b/docs/zh-CN/1.5.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.5.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/navigation.html b/docs/zh-CN/1.5.x/navigation.html new file mode 100644 index 0000000000..980d547646 --- /dev/null +++ b/docs/zh-CN/1.5.x/navigation.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.5.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/navigation/index.html b/docs/zh-CN/1.5.x/navigation/index.html new file mode 100644 index 0000000000..980d547646 --- /dev/null +++ b/docs/zh-CN/1.5.x/navigation/index.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.5.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/publishing.html b/docs/zh-CN/1.5.x/publishing.html new file mode 100644 index 0000000000..c175115f54 --- /dev/null +++ b/docs/zh-CN/1.5.x/publishing.html @@ -0,0 +1,311 @@ +Publishing your site · Docusaurus

1.5.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/publishing/index.html b/docs/zh-CN/1.5.x/publishing/index.html new file mode 100644 index 0000000000..c175115f54 --- /dev/null +++ b/docs/zh-CN/1.5.x/publishing/index.html @@ -0,0 +1,311 @@ +Publishing your site · Docusaurus

1.5.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests. You can easily work around this by creating a basic CircleCI config with the following contents:

+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/search.html b/docs/zh-CN/1.5.x/search.html new file mode 100644 index 0000000000..7990da2f7f --- /dev/null +++ b/docs/zh-CN/1.5.x/search.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.5.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/search/index.html b/docs/zh-CN/1.5.x/search/index.html new file mode 100644 index 0000000000..7990da2f7f --- /dev/null +++ b/docs/zh-CN/1.5.x/search/index.html @@ -0,0 +1,148 @@ +Enabling Search · Docusaurus

1.5.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/site-config.html b/docs/zh-CN/1.5.x/site-config.html new file mode 100644 index 0000000000..c1de8afdeb --- /dev/null +++ b/docs/zh-CN/1.5.x/site-config.html @@ -0,0 +1,384 @@ +siteConfig.js · Docusaurus

1.5.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/site-config/index.html b/docs/zh-CN/1.5.x/site-config/index.html new file mode 100644 index 0000000000..c1de8afdeb --- /dev/null +++ b/docs/zh-CN/1.5.x/site-config/index.html @@ -0,0 +1,384 @@ +siteConfig.js · Docusaurus

1.5.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/site-creation.html b/docs/zh-CN/1.5.x/site-creation.html new file mode 100644 index 0000000000..8bf2c7d21e --- /dev/null +++ b/docs/zh-CN/1.5.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.5.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.5.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.5.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.5.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.5.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.5.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/site-creation/index.html b/docs/zh-CN/1.5.x/site-creation/index.html new file mode 100644 index 0000000000..8bf2c7d21e --- /dev/null +++ b/docs/zh-CN/1.5.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.5.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.5.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.5.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.5.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.5.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.5.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/site-preparation.html b/docs/zh-CN/1.5.x/site-preparation.html new file mode 100644 index 0000000000..ca0ff8cd09 --- /dev/null +++ b/docs/zh-CN/1.5.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.5.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 与 website/core/Footer.js 文件，但可以根据需要编辑它们。

+

您不能删除 website/pages 与 website/static 文件夹，但可以根据需要更改其中内容。 在 website/pages 文件夹内您至少应该有一个 en/index.js 或 en/index.html 文件，在 website/static 文件夹内至少应该有一个页头图标文件。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/site-preparation/index.html b/docs/zh-CN/1.5.x/site-preparation/index.html new file mode 100644 index 0000000000..ca0ff8cd09 --- /dev/null +++ b/docs/zh-CN/1.5.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.5.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 与 website/core/Footer.js 文件，但可以根据需要编辑它们。

+

您不能删除 website/pages 与 website/static 文件夹，但可以根据需要更改其中内容。 在 website/pages 文件夹内您至少应该有一个 en/index.js 或 en/index.html 文件，在 website/static 文件夹内至少应该有一个页头图标文件。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/translation.html b/docs/zh-CN/1.5.x/translation.html new file mode 100644 index 0000000000..f3c7641398 --- /dev/null +++ b/docs/zh-CN/1.5.x/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.5.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/translation/index.html b/docs/zh-CN/1.5.x/translation/index.html new file mode 100644 index 0000000000..f3c7641398 --- /dev/null +++ b/docs/zh-CN/1.5.x/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.5.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/versioning.html b/docs/zh-CN/1.5.x/versioning.html new file mode 100644 index 0000000000..1e75789be2 --- /dev/null +++ b/docs/zh-CN/1.5.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.5.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.5.x/versioning/index.html b/docs/zh-CN/1.5.x/versioning/index.html new file mode 100644 index 0000000000..1e75789be2 --- /dev/null +++ b/docs/zh-CN/1.5.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.5.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/adding-blog.html b/docs/zh-CN/1.6.x/adding-blog.html new file mode 100644 index 0000000000..f0d169aa82 --- /dev/null +++ b/docs/zh-CN/1.6.x/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/adding-blog/index.html b/docs/zh-CN/1.6.x/adding-blog/index.html new file mode 100644 index 0000000000..f0d169aa82 --- /dev/null +++ b/docs/zh-CN/1.6.x/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/api-pages.html b/docs/zh-CN/1.6.x/api-pages.html new file mode 100644 index 0000000000..67a15996af --- /dev/null +++ b/docs/zh-CN/1.6.x/api-pages.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.6.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/api-pages/index.html b/docs/zh-CN/1.6.x/api-pages/index.html new file mode 100644 index 0000000000..67a15996af --- /dev/null +++ b/docs/zh-CN/1.6.x/api-pages/index.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.6.x

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/blog.html b/docs/zh-CN/1.6.x/blog.html new file mode 100644 index 0000000000..e277f348e9 --- /dev/null +++ b/docs/zh-CN/1.6.x/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/blog/index.html b/docs/zh-CN/1.6.x/blog/index.html new file mode 100644 index 0000000000..e277f348e9 --- /dev/null +++ b/docs/zh-CN/1.6.x/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.6.x

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/commands.html b/docs/zh-CN/1.6.x/commands.html new file mode 100644 index 0000000000..fe0463e7ed --- /dev/null +++ b/docs/zh-CN/1.6.x/commands.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.6.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/commands/index.html b/docs/zh-CN/1.6.x/commands/index.html new file mode 100644 index 0000000000..fe0463e7ed --- /dev/null +++ b/docs/zh-CN/1.6.x/commands/index.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.6.x

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/custom-pages.html b/docs/zh-CN/1.6.x/custom-pages.html new file mode 100644 index 0000000000..4263b67eab --- /dev/null +++ b/docs/zh-CN/1.6.x/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.6.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/custom-pages/index.html b/docs/zh-CN/1.6.x/custom-pages/index.html new file mode 100644 index 0000000000..4263b67eab --- /dev/null +++ b/docs/zh-CN/1.6.x/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.6.x

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/doc-markdown.html b/docs/zh-CN/1.6.x/doc-markdown.html new file mode 100644 index 0000000000..85a134df51 --- /dev/null +++ b/docs/zh-CN/1.6.x/doc-markdown.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.6.x

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/doc-markdown/index.html b/docs/zh-CN/1.6.x/doc-markdown/index.html new file mode 100644 index 0000000000..85a134df51 --- /dev/null +++ b/docs/zh-CN/1.6.x/doc-markdown/index.html @@ -0,0 +1,237 @@ +Markdown Features · Docusaurus

1.6.x

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/docker.html b/docs/zh-CN/1.6.x/docker.html new file mode 100644 index 0000000000..938f426f9e --- /dev/null +++ b/docs/zh-CN/1.6.x/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.6.x

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/docker/index.html b/docs/zh-CN/1.6.x/docker/index.html new file mode 100644 index 0000000000..938f426f9e --- /dev/null +++ b/docs/zh-CN/1.6.x/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.6.x

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/installation.html b/docs/zh-CN/1.6.x/installation.html new file mode 100644 index 0000000000..62c1655d3f --- /dev/null +++ b/docs/zh-CN/1.6.x/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.6.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/installation/index.html b/docs/zh-CN/1.6.x/installation/index.html new file mode 100644 index 0000000000..62c1655d3f --- /dev/null +++ b/docs/zh-CN/1.6.x/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.6.x

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/navigation.html b/docs/zh-CN/1.6.x/navigation.html new file mode 100644 index 0000000000..9fc27203b4 --- /dev/null +++ b/docs/zh-CN/1.6.x/navigation.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.6.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/navigation/index.html b/docs/zh-CN/1.6.x/navigation/index.html new file mode 100644 index 0000000000..9fc27203b4 --- /dev/null +++ b/docs/zh-CN/1.6.x/navigation/index.html @@ -0,0 +1,307 @@ +Navigation and Sidebars · Docusaurus

1.6.x

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/publishing.html b/docs/zh-CN/1.6.x/publishing.html new file mode 100644 index 0000000000..6240fd3637 --- /dev/null +++ b/docs/zh-CN/1.6.x/publishing.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.6.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/publishing/index.html b/docs/zh-CN/1.6.x/publishing/index.html new file mode 100644 index 0000000000..6240fd3637 --- /dev/null +++ b/docs/zh-CN/1.6.x/publishing/index.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.6.x

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/search.html b/docs/zh-CN/1.6.x/search.html new file mode 100644 index 0000000000..d74424720f --- /dev/null +++ b/docs/zh-CN/1.6.x/search.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.6.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/search/index.html b/docs/zh-CN/1.6.x/search/index.html new file mode 100644 index 0000000000..d74424720f --- /dev/null +++ b/docs/zh-CN/1.6.x/search/index.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.6.x

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/site-config.html b/docs/zh-CN/1.6.x/site-config.html new file mode 100644 index 0000000000..648429acc9 --- /dev/null +++ b/docs/zh-CN/1.6.x/site-config.html @@ -0,0 +1,386 @@ +siteConfig.js · Docusaurus

1.6.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/site-config/index.html b/docs/zh-CN/1.6.x/site-config/index.html new file mode 100644 index 0000000000..648429acc9 --- /dev/null +++ b/docs/zh-CN/1.6.x/site-config/index.html @@ -0,0 +1,386 @@ +siteConfig.js · Docusaurus

1.6.x

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/site-creation.html b/docs/zh-CN/1.6.x/site-creation.html new file mode 100644 index 0000000000..13beceef4e --- /dev/null +++ b/docs/zh-CN/1.6.x/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.6.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.6.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.6.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.6.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.6.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.6.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/site-creation/index.html b/docs/zh-CN/1.6.x/site-creation/index.html new file mode 100644 index 0000000000..13beceef4e --- /dev/null +++ b/docs/zh-CN/1.6.x/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.6.x

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.6.x/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.6.x/site-config), following the comments included in the [docs](/docs/zh-CN/1.6.x/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.6.x/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.6.x/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/site-preparation.html b/docs/zh-CN/1.6.x/site-preparation.html new file mode 100644 index 0000000000..37d7151975 --- /dev/null +++ b/docs/zh-CN/1.6.x/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.6.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/site-preparation/index.html b/docs/zh-CN/1.6.x/site-preparation/index.html new file mode 100644 index 0000000000..37d7151975 --- /dev/null +++ b/docs/zh-CN/1.6.x/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.6.x

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/translation.html b/docs/zh-CN/1.6.x/translation.html new file mode 100644 index 0000000000..ad03ee4759 --- /dev/null +++ b/docs/zh-CN/1.6.x/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.6.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/translation/index.html b/docs/zh-CN/1.6.x/translation/index.html new file mode 100644 index 0000000000..ad03ee4759 --- /dev/null +++ b/docs/zh-CN/1.6.x/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.6.x

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/versioning.html b/docs/zh-CN/1.6.x/versioning.html new file mode 100644 index 0000000000..cfa679917c --- /dev/null +++ b/docs/zh-CN/1.6.x/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.6.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.6.x/versioning/index.html b/docs/zh-CN/1.6.x/versioning/index.html new file mode 100644 index 0000000000..cfa679917c --- /dev/null +++ b/docs/zh-CN/1.6.x/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.6.x

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/adding-blog.html b/docs/zh-CN/1.7.3/adding-blog.html new file mode 100644 index 0000000000..28da1affda --- /dev/null +++ b/docs/zh-CN/1.7.3/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/adding-blog/index.html b/docs/zh-CN/1.7.3/adding-blog/index.html new file mode 100644 index 0000000000..28da1affda --- /dev/null +++ b/docs/zh-CN/1.7.3/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/api-pages.html b/docs/zh-CN/1.7.3/api-pages.html new file mode 100644 index 0000000000..5e83c75b1d --- /dev/null +++ b/docs/zh-CN/1.7.3/api-pages.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.7.3

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/api-pages/index.html b/docs/zh-CN/1.7.3/api-pages/index.html new file mode 100644 index 0000000000..5e83c75b1d --- /dev/null +++ b/docs/zh-CN/1.7.3/api-pages/index.html @@ -0,0 +1,269 @@ +Pages and Styles · Docusaurus

1.7.3

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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 directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/blog.html b/docs/zh-CN/1.7.3/blog.html new file mode 100644 index 0000000000..73d0bb7908 --- /dev/null +++ b/docs/zh-CN/1.7.3/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/blog/index.html b/docs/zh-CN/1.7.3/blog/index.html new file mode 100644 index 0000000000..73d0bb7908 --- /dev/null +++ b/docs/zh-CN/1.7.3/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.7.3

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/commands.html b/docs/zh-CN/1.7.3/commands.html new file mode 100644 index 0000000000..dc6019f047 --- /dev/null +++ b/docs/zh-CN/1.7.3/commands.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.7.3

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/commands/index.html b/docs/zh-CN/1.7.3/commands/index.html new file mode 100644 index 0000000000..dc6019f047 --- /dev/null +++ b/docs/zh-CN/1.7.3/commands/index.html @@ -0,0 +1,230 @@ +CLI Commands · Docusaurus

1.7.3

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/custom-pages.html b/docs/zh-CN/1.7.3/custom-pages.html new file mode 100644 index 0000000000..3070a5ccc1 --- /dev/null +++ b/docs/zh-CN/1.7.3/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.7.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/custom-pages/index.html b/docs/zh-CN/1.7.3/custom-pages/index.html new file mode 100644 index 0000000000..3070a5ccc1 --- /dev/null +++ b/docs/zh-CN/1.7.3/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.7.3

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/doc-markdown.html b/docs/zh-CN/1.7.3/doc-markdown.html new file mode 100644 index 0000000000..c25e800a4f --- /dev/null +++ b/docs/zh-CN/1.7.3/doc-markdown.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.7.3

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/doc-markdown/index.html b/docs/zh-CN/1.7.3/doc-markdown/index.html new file mode 100644 index 0000000000..c25e800a4f --- /dev/null +++ b/docs/zh-CN/1.7.3/doc-markdown/index.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.7.3

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/docker.html b/docs/zh-CN/1.7.3/docker.html new file mode 100644 index 0000000000..c6174c503f --- /dev/null +++ b/docs/zh-CN/1.7.3/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.7.3

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/docker/index.html b/docs/zh-CN/1.7.3/docker/index.html new file mode 100644 index 0000000000..c6174c503f --- /dev/null +++ b/docs/zh-CN/1.7.3/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.7.3

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/installation.html b/docs/zh-CN/1.7.3/installation.html new file mode 100644 index 0000000000..82f0fe640d --- /dev/null +++ b/docs/zh-CN/1.7.3/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.7.3

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/installation/index.html b/docs/zh-CN/1.7.3/installation/index.html new file mode 100644 index 0000000000..82f0fe640d --- /dev/null +++ b/docs/zh-CN/1.7.3/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.7.3

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. 在 website 目录下，运行本地 web 服务器：yarn start 或 npm start。

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend : 
+ "<red>"    : Major Update backward-incompatible updates 
+ "<yellow>" : Minor Update backward-compatible features 
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL                                          
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/navigation.html b/docs/zh-CN/1.7.3/navigation.html new file mode 100644 index 0000000000..8962b880a9 --- /dev/null +++ b/docs/zh-CN/1.7.3/navigation.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.7.3

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/navigation/index.html b/docs/zh-CN/1.7.3/navigation/index.html new file mode 100644 index 0000000000..8962b880a9 --- /dev/null +++ b/docs/zh-CN/1.7.3/navigation/index.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.7.3

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/publishing.html b/docs/zh-CN/1.7.3/publishing.html new file mode 100644 index 0000000000..5d9b6ce1c4 --- /dev/null +++ b/docs/zh-CN/1.7.3/publishing.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.7.3

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/publishing/index.html b/docs/zh-CN/1.7.3/publishing/index.html new file mode 100644 index 0000000000..5d9b6ce1c4 --- /dev/null +++ b/docs/zh-CN/1.7.3/publishing/index.html @@ -0,0 +1,321 @@ +Publishing your site · Docusaurus

1.7.3

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus (but it can also be accessed via https://docusaurus.io/ because of a CNAME), because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/search.html b/docs/zh-CN/1.7.3/search.html new file mode 100644 index 0000000000..ff1d715e5e --- /dev/null +++ b/docs/zh-CN/1.7.3/search.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.7.3

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/search/index.html b/docs/zh-CN/1.7.3/search/index.html new file mode 100644 index 0000000000..ff1d715e5e --- /dev/null +++ b/docs/zh-CN/1.7.3/search/index.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.7.3

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/site-config.html b/docs/zh-CN/1.7.3/site-config.html new file mode 100644 index 0000000000..8db78af9a5 --- /dev/null +++ b/docs/zh-CN/1.7.3/site-config.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.7.3

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/site-config/index.html b/docs/zh-CN/1.7.3/site-config/index.html new file mode 100644 index 0000000000..8db78af9a5 --- /dev/null +++ b/docs/zh-CN/1.7.3/site-config/index.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.7.3

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/site-creation.html b/docs/zh-CN/1.7.3/site-creation.html new file mode 100644 index 0000000000..d5e7f6cf66 --- /dev/null +++ b/docs/zh-CN/1.7.3/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.7.3

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.7.3/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.7.3/site-config), following the comments included in the [docs](/docs/zh-CN/1.7.3/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.7.3/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.7.3/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/site-creation/index.html b/docs/zh-CN/1.7.3/site-creation/index.html new file mode 100644 index 0000000000..d5e7f6cf66 --- /dev/null +++ b/docs/zh-CN/1.7.3/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.7.3

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/1.7.3/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/1.7.3/site-config), following the comments included in the [docs](/docs/zh-CN/1.7.3/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/1.7.3/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/1.7.3/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/site-preparation.html b/docs/zh-CN/1.7.3/site-preparation.html new file mode 100644 index 0000000000..ff5b90883e --- /dev/null +++ b/docs/zh-CN/1.7.3/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.7.3

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/site-preparation/index.html b/docs/zh-CN/1.7.3/site-preparation/index.html new file mode 100644 index 0000000000..ff5b90883e --- /dev/null +++ b/docs/zh-CN/1.7.3/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.7.3

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/translation.html b/docs/zh-CN/1.7.3/translation.html new file mode 100644 index 0000000000..d42fe53535 --- /dev/null +++ b/docs/zh-CN/1.7.3/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.7.3

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/translation/index.html b/docs/zh-CN/1.7.3/translation/index.html new file mode 100644 index 0000000000..d42fe53535 --- /dev/null +++ b/docs/zh-CN/1.7.3/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.7.3

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/versioning.html b/docs/zh-CN/1.7.3/versioning.html new file mode 100644 index 0000000000..9729a99c59 --- /dev/null +++ b/docs/zh-CN/1.7.3/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.7.3

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/1.7.3/versioning/index.html b/docs/zh-CN/1.7.3/versioning/index.html new file mode 100644 index 0000000000..9729a99c59 --- /dev/null +++ b/docs/zh-CN/1.7.3/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.7.3

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/adding-blog.html b/docs/zh-CN/adding-blog.html new file mode 100644 index 0000000000..8baf9e90e8 --- /dev/null +++ b/docs/zh-CN/adding-blog.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/adding-blog/index.html b/docs/zh-CN/adding-blog/index.html new file mode 100644 index 0000000000..8baf9e90e8 --- /dev/null +++ b/docs/zh-CN/adding-blog/index.html @@ -0,0 +1,198 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/api-pages.html b/docs/zh-CN/api-pages.html new file mode 100644 index 0000000000..4197b78132 --- /dev/null +++ b/docs/zh-CN/api-pages.html @@ -0,0 +1,270 @@ +Pages and Styles · Docusaurus

1.8.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/api-pages/index.html b/docs/zh-CN/api-pages/index.html new file mode 100644 index 0000000000..4197b78132 --- /dev/null +++ b/docs/zh-CN/api-pages/index.html @@ -0,0 +1,270 @@ +Pages and Styles · Docusaurus

1.8.0

Translate

Pages and Styles

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/blog.html b/docs/zh-CN/blog.html new file mode 100644 index 0000000000..9cd47bd8f8 --- /dev/null +++ b/docs/zh-CN/blog.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/blog/index.html b/docs/zh-CN/blog/index.html new file mode 100644 index 0000000000..9cd47bd8f8 --- /dev/null +++ b/docs/zh-CN/blog/index.html @@ -0,0 +1,148 @@ +Adding a Blog · Docusaurus

1.8.0

Translate

Adding a Blog

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
\ No newline at end of file diff --git a/docs/zh-CN/commands.html b/docs/zh-CN/commands.html new file mode 100644 index 0000000000..5ceac3dab7 --- /dev/null +++ b/docs/zh-CN/commands.html @@ -0,0 +1,231 @@ +CLI Commands · Docusaurus

1.8.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
--skip-next-releasefalse启用版本管理时，跳过下一个版本文档。 这不会为 /docs 目录中的文档生成 HTML 文件。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/commands/index.html b/docs/zh-CN/commands/index.html new file mode 100644 index 0000000000..5ceac3dab7 --- /dev/null +++ b/docs/zh-CN/commands/index.html @@ -0,0 +1,231 @@ +CLI Commands · Docusaurus

1.8.0

Translate

CLI Commands

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
--skip-next-releasefalse启用版本管理时，跳过下一个版本文档。 这不会为 /docs 目录中的文档生成 HTML 文件。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/custom-pages.html b/docs/zh-CN/custom-pages.html new file mode 100644 index 0000000000..1182dcf580 --- /dev/null +++ b/docs/zh-CN/custom-pages.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.8.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/custom-pages/index.html b/docs/zh-CN/custom-pages/index.html new file mode 100644 index 0000000000..1182dcf580 --- /dev/null +++ b/docs/zh-CN/custom-pages/index.html @@ -0,0 +1,150 @@ +Custom Pages · Docusaurus

1.8.0

Translate

Custom Pages

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/doc-markdown.html b/docs/zh-CN/doc-markdown.html new file mode 100644 index 0000000000..881c5f9e46 --- /dev/null +++ b/docs/zh-CN/doc-markdown.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.8.0

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/doc-markdown/index.html b/docs/zh-CN/doc-markdown/index.html new file mode 100644 index 0000000000..881c5f9e46 --- /dev/null +++ b/docs/zh-CN/doc-markdown/index.html @@ -0,0 +1,247 @@ +Markdown Features · Docusaurus

1.8.0

Translate

Markdown Features

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
    ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('root'));
+    ```
+
+...would be rendered with syntax highlighting like so:
+
+```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/docker.html b/docs/zh-CN/docker.html new file mode 100644 index 0000000000..8bf1ec3861 --- /dev/null +++ b/docs/zh-CN/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.8.0

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/docker/index.html b/docs/zh-CN/docker/index.html new file mode 100644 index 0000000000..8bf1ec3861 --- /dev/null +++ b/docs/zh-CN/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

1.8.0

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/installation.html b/docs/zh-CN/installation.html new file mode 100644 index 0000000000..db4f66d3e6 --- /dev/null +++ b/docs/zh-CN/installation.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.8.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/installation/index.html b/docs/zh-CN/installation/index.html new file mode 100644 index 0000000000..db4f66d3e6 --- /dev/null +++ b/docs/zh-CN/installation/index.html @@ -0,0 +1,189 @@ +Installation · Docusaurus

1.8.0

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/navigation.html b/docs/zh-CN/navigation.html new file mode 100644 index 0000000000..5d43fe2489 --- /dev/null +++ b/docs/zh-CN/navigation.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.8.0

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/navigation/index.html b/docs/zh-CN/navigation/index.html new file mode 100644 index 0000000000..5d43fe2489 --- /dev/null +++ b/docs/zh-CN/navigation/index.html @@ -0,0 +1,314 @@ +Navigation and Sidebars · Docusaurus

1.8.0

Translate

Navigation and Sidebars

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/next/adding-blog.html b/docs/zh-CN/next/adding-blog.html new file mode 100644 index 0000000000..2efc105e69 --- /dev/null +++ b/docs/zh-CN/next/adding-blog.html @@ -0,0 +1,198 @@ +添加博客 · Docusaurus

next

Translate

添加博客

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/next/adding-blog/index.html b/docs/zh-CN/next/adding-blog/index.html new file mode 100644 index 0000000000..2efc105e69 --- /dev/null +++ b/docs/zh-CN/next/adding-blog/index.html @@ -0,0 +1,198 @@ +添加博客 · Docusaurus

next

Translate

添加博客

初始设置

+

To setup your site's blog, start by creating a blog directory within your repo's website directory.

+

然后, 在 siteConfig.js 中添加一个指向您博客的 headerLinks:

+
headerLinks: [
+    ...
+    { blog: true, label: 'Blog' },
+    ...
+]
+
+

添加文章

+

To publish in the blog, create a file within the blog directory with a formatted name of YYYY-MM-DD-My-Blog-Post-Title.md. The post date is extracted from the file name.

+

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

+
---
+author: Frank Li
+authorURL: https://twitter.com/foobarbaz
+authorFBID: 503283835
+title: Introducing Docusaurus
+---
+
+Lorem Ipsum...
+
+

顶部选项

+

唯一必填项是 title；但是, 我们还提供了添加可选的文章作者信息的功能。

+
    +
  • author - 作者署名的文本标签。
    • +
  • authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
    • +
  • authorFBID - The Facebook profile ID that is used to fetch the profile picture.
    • +
  • authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
    • +
  • title - The blog post title.
    • +
+

摘要截取

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：

+
---
+title: Truncation Example
+---
+
+All this will be part of the blog post summary.
+
+Even this.
+
+<!--truncate-->
+
+But anything from here on down will not be.
+
+Not this.
+
+Or this.
+
+

修改侧边栏可见的文章数

+

默认情况下，侧边栏会显示最近的5篇文章。

+

你可以在 siteConfig.js中添加 blogSidebarCount属性，来配置你的想要展示的文章数。

+

The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.

+

例如：

+
blogSidebarCount: 'ALL';
+
+

Changing The Sidebar Title

+

You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.

+

The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.

+

例如：

+
blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' },
+
+

RSS订阅

+

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 characters are used.

+

社交按钮

+

如果想在文章底部显示Facebook与(或)Twitter社交按钮，那么在网站设置的siteConfig.js中配置facebookAppId 与(或) twitter选项。

+

Advanced Topics

+

I want to run in "Blog Only" mode.

+

You can run your Docusaurus site without a landing page and instead have your blog load first.

+

To do this:

+
    +
  1. Create a file index.html in website/static/.
    2. +
  2. Place the contents of the template below into website/static/index.html
    3. +
  3. Customize the <title> of website/static/index.html
    4. +
  4. Delete the dynamic landing page website/pages/en/index.js
    5. +
+
+

Now, when Docusaurus generates or builds your site, it will copy the file from static/index.html and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads it will redirect the visitor to /blog.

+
+

You can use this template:

+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=blog/">
+    <script type="text/javascript">
+      window.location.href = 'blog/';
+    </script>
+    <title>Title of Your Blog</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+  </body>
+</html>
+
+
← Docker自定义-页面 →
\ No newline at end of file diff --git a/docs/zh-CN/next/api-pages.html b/docs/zh-CN/next/api-pages.html new file mode 100644 index 0000000000..657f6fb2af --- /dev/null +++ b/docs/zh-CN/next/api-pages.html @@ -0,0 +1,270 @@ +页面和样式 · Docusaurus

next

Translate

页面和样式

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/next/api-pages/index.html b/docs/zh-CN/next/api-pages/index.html new file mode 100644 index 0000000000..657f6fb2af --- /dev/null +++ b/docs/zh-CN/next/api-pages/index.html @@ -0,0 +1,270 @@ +页面和样式 · Docusaurus

next

Translate

页面和样式

Docusaurus provides support for writing pages as React components inside the website/pages directory which will share the same header, footer, and styles as the rest of the site.

+

Provided Props

+

Docusaurus provides your siteConfig.js as a config props. Hence, you can access baseUrl or title through this props.

+

示例

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    const siteConfig = this.props.config;
+    return <div>{siteConfig.title}</div>;
+  }
+}
+
+module.exports = MyPage;
+
+

URLs for Pages

+

Any .js files in website/pages will be rendered to static HTML using the path of the file after pages. website/pages/en中的文件也将会被复制到pages中并且会覆盖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.

+

Titles for Pages

+

By default, the title of your page is <title> • <tagline> where title and tagline fields are set in siteConfig.js. You can exclude the tagline in the title by setting disableTitleTagline to true. If you want to set a specific title for your custom pages, add a title class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.title = 'My Custom Title';
+
+module.exports = MyPage;
+
+

Description for Pages

+

By default, the description your page is tagline set in siteConfig.js. If you want to set a specific description for your custom pages, add a description class property on your exported React component.

+

例如：

+
const React = require('react');
+
+class MyPage extends React.Component {
+  render() {
+    // ... your rendering code
+  }
+}
+
+MyPage.description = 'My Custom Description';
+
+module.exports = MyPage;
+
+

This will be translated to a description metadata tag on the generated HTML.

+
<meta property="og:description" content="My Custom Description"/>
+<meta name="description" content="My Custom Description"/>
+
+

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 directory 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 directory, use process.cwd() which will refer to the website directory 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.MarkdownBlock

+

A React component that parses markdown and renders to HTML.

+

例如：

+
const MarkdownBlock = CompLibrary.MarkdownBlock;
+
+<MarkdownBlock>
+  [Markdown syntax for a link](http://www.example.com)
+</MarkdownBlock>;
+
+

CompLibrary.Container

+

A React container component using Docusaurus styles. Has optional padding and background color props that you can configure.

+

Props

+ + + + + + + + + +
PropType默认说明
paddingArray of 'all', 'bottom', 'left', 'right', 'top'[]Positions of the padding.
backgroundOne of 'dark', 'highlight', 'light'nullBackground styling of the element.
classNameString-Custom class to add to the element.
+

示例

+
<Container
+  padding={['bottom', 'top']}
+  background="light"
+  className="myCustomClass">
+  ...
+</Container>
+
+

CompLibrary.GridBlock

+

A React component to organize text and images.

+

Props

+ + + + + + + + + + +
PropType默认说明
alignOne of 'left', 'center', 'right''left'Text alignment of content.
layoutOne of 'twoColumn', 'threeColumn', 'fourColumn''twoColumn'Number of column sections in the GridBlock.
classNameString-Custom class to add to the element.
contentsArray of content objects[]Contents of each section of the GridBlock. Refer to the next table for the fields available on a content object.
+

Content Object

+ + + + + + + + + + + + +
KeyType默认说明
titleString-The display title of this section, which is parsed using Markdown
contentString-The text of this section, which is parsed using Markdown
imageString-The path of the display image
imageAltString-The text that will be shown in case the image is not available
imageAlignOne of 'top', 'left', 'bottom', 'right''left'Image alignment relative to the text
imageLinkString-Link destination from clicking the image
+

示例

+
<GridBlock
+  align="center"
+  layout="threeColumn"
+  className="myCustomClass"
+  contents={[
+    {
+      title: `[Learn](${siteConfig.baseUrl}${siteConfig.docsUrl}/tutorial.html)`,
+      content: 'Learn how to use this project',
+      image: siteConfig.baseUrl + 'img/learn.png',
+      imageAlt: 'Learn how to use this project',
+      imageLink: siteConfig.baseUrl + 'docs/tutorial.html',
+    },
+    {
+      title: 'Frequently Asked Questions',
+      content: 'Questions gathered from the community',
+      image: siteConfig.baseUrl + 'img/faq.png',
+      imageAlign: 'top',
+    },
+    {
+      title: 'More',
+      content: 'Lots of documentation is on this site',
+    },
+  ]}
+/>
+
+

More examples of how these components are used can be found in the generated example files as well as in Docusaurus' own repository 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 directory. They can be accessed 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.

+

There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

+

You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' 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.

+
← Markdown 特性siteConfig.js →
\ No newline at end of file diff --git a/docs/zh-CN/next/commands.html b/docs/zh-CN/next/commands.html new file mode 100644 index 0000000000..ad6f2f5ef2 --- /dev/null +++ b/docs/zh-CN/next/commands.html @@ -0,0 +1,231 @@ +CLI 命令 · Docusaurus

next

Translate

CLI 命令

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
--skip-next-releasefalse启用版本管理时，跳过下一个版本文档。 这不会为 /docs 目录中的文档生成 HTML 文件。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/next/commands/index.html b/docs/zh-CN/next/commands/index.html new file mode 100644 index 0000000000..ad6f2f5ef2 --- /dev/null +++ b/docs/zh-CN/next/commands/index.html @@ -0,0 +1,231 @@ +CLI 命令 · Docusaurus

next

Translate

CLI 命令

Docusaurus 提供了一组脚本来帮助您生成、服务和配置您的网站。 使用 Yarn 或 npm 时, 可以使用 run 命令调用这些脚本。 一些常见的命令如下:

+ +

从命令行运行

+

这些脚本可以使用 Yarn 或 npm 来运行。 如果您已经完成了我们的入门指南, 您可能已经熟悉了 start 命令。 这是这样的命令,：它告诉 Docusaurus 运行 Docusaurus-start 脚本, 它生成站点并启动服务器, 通常是这样调用的:

+
yarn run start
+
+

也可以使用 npm 调用相同的脚本:

+
npm run start
+
+

若要运行特定的脚本, 只需用与脚本关联的命令替换上面示例中的 start 命令。

+

使用参数

+

一些命令支持可选参数 例如，为了在端口80800上启动服务器，您可以在运行 “start” 时指定 “--port” 参数：

+
yarn run start -- port 8080
+
+

如果使用 npm 运行 Docusaurus, 则仍然可以通过在 npm run <command> 和命令参数之间插入 -- 来使用命令行参数:

+
npm run start -- --port 8080
+
+

配置

+

这些脚本是在 website/package.json 文件的 "scripts" 项下设置的, 作为安装过程的一部分。 如果需要帮助再次设置它们, 请参阅 安装指南 。

+

Docusaurus 提供了一些默认的映像, 允许您按照节点约定运行命令。 您可以键入 yarn run start 或 npm start 来实现相同的目的, 而不是每次都键入 docusaurus-start。

+

命令

+ +
+

参考

+

docusaurus-build

+

别名︰ build。

+ + + + + + + + +
可选项默认说明
--skip-image-compressionfalse忽略图片资源压缩。 通常都不会跳过图片资源压缩，除非你的图片资源已经优化过。
--skip-next-releasefalse启用版本管理时，跳过下一个版本文档。 这不会为 /docs 目录中的文档生成 HTML 文件。
+

生成静态站点，必要时会应用翻译。 适用于部署前构建站点。

+

另请参阅 docusaurus-start。

+
+

docusaurus-examples

+

别名：examples

+ + + + + + + +
参数默认说明
<feature>-指定附加功能 translations 或 versions，以生成附加功能的额外文件。
+

示例

+
docusaurus-示例 <feature>
+
+

如果没有指定附加功能，则会在你的项目中设置一个最小化配置的示例站点。 Site Preparation guide 中会深入介绍此命令。

+
+

docusaurus-publish

+

别名: publish-gh-pages

+

Builds，然后在 GitHub Pages 上部署静态网站。 此命令会在 Circle Ci 部署步骤中运行，因此需要定义一些环境变量：

+

以下环境变量通常由用户在 CircleCI 的 config.yml 文件中手动设置。

+
    +
  • GIT_USER：与部署相关的 GIT 用户。
    • +
  • USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
    • +
+

示例

+
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
+
+

The following environment variables are set by CircleCI during the build process.

+
    +
  • CIRCLE_BRANCH：与触发 CI 运行的 commit 相关联的 git 分支。
    • +
  • CI_PULL_REQUEST: 如果当前 CI 运行是通过请求中的提交触发的, 则认定为真。
    • +
+

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

+
    +
  • CIRCLE_PROJECT_USERNAME: 本网站git仓库的 GitHub 用户名或组织名称, 例如 "facebook"。
    • +
  • CIRCLE_PROJECT_REPONAME: 本网站git仓库的名称, 例如："Docusaurus"。
    • +
+

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

+
+

docusaurus-rename-version

+

Alias: rename-version

+

Renames an existing version of the docs to a new version name.

+ + + + + + + + +
参数默认说明
<currentVersion>-Version to be renamed.
<newVersion>-Version to be renamed to.
+

示例

+
docusaurus-rename-version <currentVersion> <newVersion>
+
+

See the Versioning guide to learn more.

+
+

docusaurus-start

+

Alias: start.

+

This command will build the static website, apply translations if necessary, and then start a local server.

+ + + + + + + + +
可选项默认说明
--port <number>3000网站将默认使用端口3000提供服务，但如果被占用，Docusarus将试图使用其他可用的端口。
--watch-是否要监视文件的变化，以便再文件内容变化时重新载入并实时展现。 默认值为 true。 使用 --no-watch禁用此功能。
+

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

+
$ BROWSER=firefox yarn start
+
+
+

docusaurus-版本 <版本>

+

Alias: version

+

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

+

See the Versioning guide to learn more.

+
+

docusaurus-书写-翻译

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.

+
← 版本管理Markdown 特性 →
\ No newline at end of file diff --git a/docs/zh-CN/next/custom-pages.html b/docs/zh-CN/next/custom-pages.html new file mode 100644 index 0000000000..4009e3df73 --- /dev/null +++ b/docs/zh-CN/next/custom-pages.html @@ -0,0 +1,150 @@ +自定义-页面 · Docusaurus

next

Translate

自定义-页面

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/next/custom-pages/index.html b/docs/zh-CN/next/custom-pages/index.html new file mode 100644 index 0000000000..4009e3df73 --- /dev/null +++ b/docs/zh-CN/next/custom-pages/index.html @@ -0,0 +1,150 @@ +自定义-页面 · Docusaurus

next

Translate

自定义-页面

You can add pages to your site that are not part of the standard docs or blog markdown files. You can do this by adding .js files to the website/pages directory. These files are React components and the render() is called to create them, backed by CSS classes, etc.

+

自定义您的主页

+

The easiest way to get started customizing your home page is to use the example site that was created when you ran the Docusaurus initialization script.

+

You can start your local server and go to http://localhost:3000 to see what the example home page looks like. 在那里，编辑website/pages/en/index.js文件以及它的各种组件来使用你的这个项目需要用到的图像和文本。

+

加入其它自定义页面

+

Docusaurus 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-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    │   ├── index.js
+    │   ├── users.js
+    │   └── help.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

Of course, you are also free to write your own pages. It is strongly suggested that you at least have an index page, but none of the pages provided are mandatory to include in your site. 有关如何使用提供的组件或包含您自己的部件的详细信息, 可在 的 处找到。 有关如何链接到页眉导航栏中的不同页面的信息, 请 的 处找到。

+
+

If you want your page to show up in your navigation header, you will need to update siteConfig.js to add to the headerLinks element. e.g., { page: 'about-slash', label: 'About/' },

+
+

添加静态页面

+

Static .html files can also be used, but they will not include Docusaurus' header, footer, or styles by default. These can be added to the static directory in the same way as other static assets. Alternatively, they can be placed in the pages directory and would be served as-is instead of being rendered from React.

+

If you wish to use Docusaurus' 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' styles by adding them into the siteConfig.separateCss field in siteConfig.js.

+
+

You can set the $wrapPagesHTML site config option in order to wrap raw HTML fragments with the Docusaurus site styling, header and footer.

+
+

自定义您的页脚

+

Starting from the example core/Footer.js file that was created when you ran the Docusaurus initialization script, edit the footer to include any links to pages on your site or other sites that you wish to have.

+

提供的例子有三部分, 左侧有页脚图像, 底部有Facebook 的开源标志和版权。 如果您的项目不是 Facebook 开源项目, 请删除标志和版权。 如果它是facebook的开源项目, 你就可以随意的使用你的页脚, 把它设计成任何你喜欢的样子！

+

一些建议你可能需要提供的链接: 文档, API （应用程序编程接口）, 推特, Discord（一种聊天软件）, facebook群组, Stack Overflow（一个IT技术问答网站）, GitHub（一个开源项目托管平台） 等。

+

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');
+
+class Footer extends React.Component {
+  render() {
+    return null;
+  }
+}
+
+module.exports = Footer;
+
+
← 添加博客启用搜索 →
\ No newline at end of file diff --git a/docs/zh-CN/next/doc-markdown.html b/docs/zh-CN/next/doc-markdown.html new file mode 100644 index 0000000000..b7468ea617 --- /dev/null +++ b/docs/zh-CN/next/doc-markdown.html @@ -0,0 +1,246 @@ +Markdown 特性 · Docusaurus

next

Translate

Markdown 特性

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/next/doc-markdown/index.html b/docs/zh-CN/next/doc-markdown/index.html new file mode 100644 index 0000000000..b7468ea617 --- /dev/null +++ b/docs/zh-CN/next/doc-markdown/index.html @@ -0,0 +1,246 @@ +Markdown 特性 · Docusaurus

next

Translate

Markdown 特性

Docusaurus uses GitHub Flavored Markdown (GFM). Find out more about Docusaurus-specific fields when writing Markdown.

+

Markdown 标题

+

文档

+

文档使用以下 markdown 协议头字段, 它们由两侧的行 --- 括起来:

+

id: A unique document id. If this field is not present, the document's id will default to its file name (without the extension).

+

title: The title of your document. If this field is not present, the document's title will default to its id.

+

hide_title: Whether to hide the title at the top of the doc.

+

sidebar_label: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's sidebar_label will default to its title.

+

例如：

+
---
+id: doc1
+title: My Document
+sidebar_label: Document
+---
+
+

经过版本控制的文档在被复制时会更改其 id 这样才能包含版本号。 新的 id 为 version-${version}-${id}, 其中 ${version} 是该文档的版本号, $ {id} 是原始的 id。 此外，版本文档可得到original_id 文件，使用原版的文件id。

+

例如：

+
---
+id: version-1.0.0-doc1
+title: My Document
+sidebar_label: Document
+original_id: doc1
+---
+
+

custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

+

例如：

+
---
+id: doc-markdown
+title: Markdown Features
+custom_edit_url: https://github.com/facebook/Docusaurus/edit/master/docs/api-doc-markdown.md
+---
+
+

博客文章

+

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

+

tittle: 此博客文章的标题。

+

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: 作者的 Facebook（脸书） id, 仅用于让作者的个人资料图片显示在博客文章中。 如果省略此字段, 则不会显示该作者的图片在这篇文章中。

+

例如：

+
---
+tittle: My First Blog Post
+author: Frank Li
+authorURL: http://twitter.com/franchementli
+authorFBID: 100002976521003
+---
+
+

更多功能

+

Docusaurus 在markdown中编写文档时支持一些额外的功能。

+

链接到其他文档

+

You can use relative URLs to other documentation files which will automatically get converted to the corresponding HTML links when they get rendered.

+

例如：

+
[This links to another document](other-document.md)
+
+

这样, markdown将把它自动转换成指向 /docs/other-document.html 的链接(或适当翻译/版本控制链接) 。

+

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.

+

链接到图像和其它资源

+

Static assets can be linked to in the same way that documents are, using relative URLs. 在文档和博客中使用的静态资产应分别进入 docs/assets 和 website/blog/assets。 Markdown 被转换成正确的链接路径, 这样这些路径就能为所有语言和版本的文档所用。

+

例如：

+
![alt-text](assets/doc-image.png)
+
+

生成目录

+

You can make an auto-generated 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 ``. 使用 h3 为标题在代码块里为每个函数编写文档。 These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

例如：

+
### `docusaurus.function(a, b)`
+
+Text describing my function
+
+### `docdoc(file)`
+
+Text describing my function
+
+

这将会把页面带去这些功能的目录：

+
- `docusaurus.function(a, b)`
+- `docdoc(file)`
+
+

每个函数将会把链接带到页面相对应的部分。

+

Language-specific Code Tabs

+

Display code in multiple programming languages using code tabs. First, mark the start and end of a code tabs group, by using <!-- DOCUSAURUS_CODE_TABS --> and <!-- END_DOCUSAURUS_CODE_TABS --> respectively in your markdown. Then start each tab with <!--[TAB_TITLE]-->.

+

Adding the following code to your Markdown file:

+ +

produces this:

+
console.log('Hello, world!');
+
print('Hello, world!')
+
#include <stdio.h>

int main() {
   printf("Hello World!");
   return 0;
}
+
program HelloWorld;
begin
  WriteLn('Hello, world!');
end.
+
+

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...

+
```js
+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) {
+        // ...
+      });
+    }
+  }
+}
+
+

Using Prism as additional syntax highlighter

+

You can also opt to use Prism to syntax highlight certain languages available in the list here. Include those languages in usePrism field in your siteConfig.js

+

例如：

+
// siteConfig.js
+usePrism: ['jsx']
+
+

Notice that the code block below uses JSX syntax highlighting from Prism.

+
class Example extends React.Component {
+  render() {
+    return (
+      <View style={{flex: 1, alignItems: 'center', justifyContent: 'center'}}>
+        <Text>Docusaurus</Text>
+        <Button
+          title="Click me"
+          onPress={() => this.props.navigation.push('Docusaurus')}
+        />
+      </View>
+    );
+  }
+}
+
+

Adding Copy Code Buttons

+

Docusaurus allows for adding buttons to copy code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

+
← CLI 命令页面和样式 →
\ No newline at end of file diff --git a/docs/zh-CN/next/docker.html b/docs/zh-CN/next/docker.html new file mode 100644 index 0000000000..d5749a900f --- /dev/null +++ b/docs/zh-CN/next/docker.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

next

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/next/docker/index.html b/docs/zh-CN/next/docker/index.html new file mode 100644 index 0000000000..d5749a900f --- /dev/null +++ b/docs/zh-CN/next/docker/index.html @@ -0,0 +1,151 @@ +Docker · Docusaurus

next

Translate

Docker

Docker is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus.

+

Run the local webserver in docker

+

Ensure you have previously installed docker.

+

To run the local webserver:

+
    +

  1. Build the docker image -- Enter the folder where you have Docusaurus installed. Run docker build -t docusaurus-doc .

    +

    Once the build phase finishes, you can verify the image exists by running docker images.

    +
    +

    We now include a Dockerfile when you install Docusaurus.

    +
    2. +

  2. Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc

    +

    This will start a docker container with the image docusaurus-doc. To see more detailed container info run docker ps .

    3. +
+

Use docker-compose

+

We can also use docker-compose to configure our application. This feature of docker allows you to run the webserver and any additional services with a single command.

+
+

Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.

+
+

Using Compose is a three-step process:

+
    +

  1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere.

    2. +

  2. Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

    3. +

  3. Run docker-compose up and Compose starts and runs your entire app.

    4. +
+

We include a basic docker-compose.yml in your project:

+
version: "3"
+
+services:
+  docusaurus:
+    build: .
+    ports:
+
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
+
+
+

To run a local webserver with docker-compose run docker-compose up.

+

To build static HTML pages for publishing run docker-compose run docusaurus bash -c 'yarn publish-gh-pages'

+
← 发布你的站点添加博客 →
\ No newline at end of file diff --git a/docs/zh-CN/next/installation.html b/docs/zh-CN/next/installation.html new file mode 100644 index 0000000000..63ac4345e6 --- /dev/null +++ b/docs/zh-CN/next/installation.html @@ -0,0 +1,189 @@ +安装 · Docusaurus

next

Translate

安装

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/next/installation/index.html b/docs/zh-CN/next/installation/index.html new file mode 100644 index 0000000000..63ac4345e6 --- /dev/null +++ b/docs/zh-CN/next/installation/index.html @@ -0,0 +1,189 @@ +安装 · Docusaurus

next

Translate

安装

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

+

安装 Docusaurus

+

我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:

+
    +

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    +
    +

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

    +
    2. +

  2. Create a project, if none exists, and change your directory to this project's root.

    +

    文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus 的安装脚本会在此创建 2 个新目录：docs-examples-from-docusaurus 与 website。

    +
    +

    通常，Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。

    +
    3. +

  3. 运行 Docusaurus 的安装脚本：npx docusaurus-init。

    +
    +

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

    +
    4. +
+

验证安装

+

Along with previously existing files and directories, your root directory will now contain a structure similar to:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+

运行示例网站

+

根据 Installation 部分所述运行完 Docusaurus 的初始化脚本 docusaurus-init 后，你将会有一个可运行的基础示例网站。 To run:

+
    +

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。

    2. +

  2. cd website

    3. +

  3. 把 blog-examples-from-docusaurus 重命名为 blog。

    4. +

  4. From within the website directory, run the local webserver using yarn start or npm start.

    5. +

  5. 如果没有自动打开本地的示例网站，请在 http://localhost:3000 访问示例站点。

    +

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

    6. +
+

+

使用代理启动服务

+

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+

Updating Your Docusaurus Version

+

在 Docusaurus 安装之后，你可以在 website 目录下查看最新版本，或是输入 yarn outdated docusaurus 或 npm outdated docusaurus 查看。

+

You will see something like this:

+
$ yarn outdated
+Using globally installed version of Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warning No license field
+info Color legend :
+ "<red>"    : Major Update backward-incompatible updates
+ "<yellow>" : Minor Update backward-compatible features
+ "<green>"  : Patch Update backward-compatible bug fixes
+Package    Current Wanted Latest Package Type    URL
+docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
+✨  Done in 0.41s.
+
+
+

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

+
+

You can update to the latest version of Docusaurus by:

+
yarn upgrade docusaurus --latest
+
+

或

+
npm update docusaurus
+
+
+

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

+
+
建站准备 →
\ No newline at end of file diff --git a/docs/zh-CN/next/navigation.html b/docs/zh-CN/next/navigation.html new file mode 100644 index 0000000000..8c1cea7612 --- /dev/null +++ b/docs/zh-CN/next/navigation.html @@ -0,0 +1,314 @@ +导航和边栏 · Docusaurus

next

Translate

导航和边栏

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/next/navigation/index.html b/docs/zh-CN/next/navigation/index.html new file mode 100644 index 0000000000..8c1cea7612 --- /dev/null +++ b/docs/zh-CN/next/navigation/index.html @@ -0,0 +1,314 @@ +导航和边栏 · Docusaurus

next

Translate

导航和边栏

Referencing Site Documents

+

If you want to reference another document in your docs directory (or the location you set via the optional customDocsPath path site configuration option), then you just use the name of the document you want to reference.

+

For example, if you are in doc2.md and you want to reference doc1.md:

+
I am referencing a [document](doc1.md).
+
+

How Documents are Linked

+

New markdown files within docs will show up as pages on the website. Links to those documents are created first by using the id in the header of each document. If there is no id field, then the name of the file will serve as the link name.

+

For example, creating an empty file such as docs/getting-started.md will enable the new page URL as /docs/getting-started.html.

+

Suppose you add this to your document:

+
id: intro
+title: Getting Started
+---
+My new content here..
+
+

If you set the id field in the markdown header of the file, the doc will then be accessed from a URL of the form /docs/intro.html.

+
+

You need an id field to be able to add the document to the sidebar.

+
+

Adding Documents to a Sidebar

+

Many times, you will want to add a document to a sidebar that will be associated with one of the headers in the top navigation bar of the website. The most common sidebar, and the one that comes installed when Docusaurus is initialized, is the docs sidebar.

+
+

"docs" is just a name. It has no inherent meaning. You can change it as you wish.

+
+

You configure the contents of the sidebar, and the order of its documents, in the website/sidebars.json file.

+
+

Until you add your document to website/sidebars.json, they will only be accessible via a direct URL. The doc will not show up in any sidebar.

+
+

Within sidebars.json, add the id you used in the document header to existing sidebar/category. In the below case, docs is the name of the sidebar and Getting Started is a category within the sidebar.

+
{
+  "docs": {
+    "Getting Started": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

或者您也可以在边栏中创建一个新类别:

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

However, for a document located in a docs subdirectory like below:

+
docs
+└── dir1
+    └── getting-started.md
+
+

You should provide directory/id instead of id in sidebars.json.

+
{
+  "docs": {
+    "My New Sidebar Category": [
+      "dir1/getting-started"
+    ],
+    ...
+  },
+  ...
+}
+
+

Adding Subcategories

+

It is possible to add subcategories to a sidebar. Instead of using IDs as the contents of the category array like the previous examples, you can pass an object where the keys will be the subcategory name and the value an array of IDs for that subcategory.

+
{
+  "docs": {
+    "My Example Category": [
+      "examples",
+      {
+        "type": "subcategory",
+        "label": "My Example Subcategory",
+        "ids": [
+          "my-examples",
+          ...
+        ]
+      },
+      {
+        "type": "subcategory",
+        "label": "My Next Subcategory",
+        "ids": [
+          "some-other-examples"
+        ]
+      },
+      "even-more-examples",
+      ...
+    ],
+    ...
+  }
+}
+
+/*
+The above will generate:
+
+- My Example Category
+  - examples
+  - My Example Subcategory
+    - my-examples
+    ...
+  - My Next Subcategory
+    - some-other-examples
+  - even-more-examples
+  ...
+*/
+
+

Adding New Sidebars

+

You can also put a document in a new sidebar. In the following example, we are creating an examples-sidebar sidebar within sidebars.json that has a category called My Example Category containing a document with an id of my-examples.

+
{
+  "examples-sidebar": {
+    "My Example Category": [
+      "my-examples"
+    ],
+    ...
+  },
+  ...
+}
+
+

It is important to note that until you add a document from the "examples-sidebar" sidebar to the nav bar, it will be hidden.

+

Additions to the Site Navigation Bar

+

To expose sidebars, you will add click-able labels to the site navigation bar at the top of the website. You can add documents, pages and external links.

+

Adding Documents

+

After creating a new sidebar for the site by adding it to sidebars.json, you can expose the new sidebar from the top navigation bar by editing the headerLinks field of siteConfig.js.

+
{
+  headerLinks: [
+    ...
+    { doc: 'my-examples', label: 'Examples' },
+    ...
+  ],
+  ...
+}
+
+

A label called Examples will be added to the site navigation bar and when you click on it at the top of your site, the examples-sidebar will be shown and the default document will be my-examples.

+

Adding Custom Pages

+

To add custom pages to the site navigation bar, entries can be added to the headerLinks of siteConfig.js. 例如, 如果我们在 website/pages/help.js 中有一个页面, 我们可以通过添加以下链接来链接到它:

+
{
+  headerLinks: [
+    ...
+    { page: 'help', label: 'Help' },
+    ...
+  ],
+  ...
+}
+
+

A label called Help will be added to the site navigation bar and when you click on it at the top of your site, the content from the help.js page will be shown.

+

Adding External Links

+

Custom links can be added to the site navigation bar with the following entry in siteConfig.js:

+
{
+  headerLinks: [
+    ...
+    { href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
+    ...
+  ],
+  ...
+}
+
+

A label called GitHub will be added to the site navigation bar and when you click on it at the top of your site, the content of the external link will be shown.

+
+

若要在新选项卡中打开外部链接, 请在标题链接配置中提供 external: true 标志。

+
+

Site Navigation Bar Positioning

+

You have limited control where the search and languages dropdown elements are shown in the site navigation bar at the top of your website.

+

Search

+

如果你的网站上启用了搜索, 你的搜索栏会先显示在链接的右侧。 如果你想将搜索栏放在页眉中的链接之间, 请在 headerLinks 配置数组中添加搜索项:

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { search: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Languages Dropdown

+

如果您的网站上翻译功能启用了, 则 "语言" 下拉菜单将显示在链接的右侧 (如果启用了搜索功能, 就位于搜索栏的左侧)。 如果你想把语言选择下拉单放在页眉链接的中间，请添加一个语言项在 headerLinks 配置数组里：

+
{
+  headerLinks: [
+    { doc: 'foo', label: 'Foo' },
+    { languages: true },
+    { doc: 'bar', label: 'Bar' },
+  ],
+  ...
+}
+
+

Active Links In Site Navigation Bar

+

The links in the top navigation bar get siteNavItemActive and siteNavGroupActive class names to allow you to style the currently active link different from the others. siteNavItemActive is applied when there's an exact match between the navigation link and the currently displayed web page.

+
+

This does not include links of type href which are meant for external links only. If you manually set an href in your headerLinks to an internal page, document, or blog post, it will not get the siteNavItemActive class even if that page is being displayed.

+
+

The siteNavGroupActive class will be added to these links:

+
    +
  • doc links that belong to the same sidebar as the currently displayed document
    • +
  • The blog link when a blog post, or the blog listing page is being displayed
    • +
+

These are two separate class names so you can have the active styles applied to either exact matches only or a bit more broadly for docs that belong together. If you don't want to make this distinction you can add both classes to the same CSS rule.

+

Secondary On-Page Navigation

+

We support secondary on-page navigation so you can more easily see the topics associated with a given document. To enable this feature, you need to add the onPageNav site configuration option to your siteConfig.js.

+
{
+  onPageNav: 'separate',
+  ...
+}
+
+

Currently, 'separate' is the only option available for this field. This provides a separate navigation on the right side of the page.

+

Collapsible Categories

+

For sites with a sizable amount of content, we support the option to expand/collapse the links and subcategories under categories. To enable this feature, set the docsSideNavCollapsible site configuration option in siteConfig.js to true.

+
{
+  docsSideNavCollapsible: true,
+  ...
+}
+
+
← 启用搜索翻译和本地化 →
\ No newline at end of file diff --git a/docs/zh-CN/next/publishing.html b/docs/zh-CN/next/publishing.html new file mode 100644 index 0000000000..c0d81c0d21 --- /dev/null +++ b/docs/zh-CN/next/publishing.html @@ -0,0 +1,322 @@ +发布你的站点 · Docusaurus

next

Translate

发布你的站点

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/next/publishing/index.html b/docs/zh-CN/next/publishing/index.html new file mode 100644 index 0000000000..c0d81c0d21 --- /dev/null +++ b/docs/zh-CN/next/publishing/index.html @@ -0,0 +1,322 @@ +发布你的站点 · Docusaurus

next

Translate

发布你的站点

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/next/search.html b/docs/zh-CN/next/search.html new file mode 100644 index 0000000000..0401be2075 --- /dev/null +++ b/docs/zh-CN/next/search.html @@ -0,0 +1,158 @@ +启用搜索 · Docusaurus

next

Translate

启用搜索

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/next/search/index.html b/docs/zh-CN/next/search/index.html new file mode 100644 index 0000000000..0401be2075 --- /dev/null +++ b/docs/zh-CN/next/search/index.html @@ -0,0 +1,158 @@ +启用搜索 · Docusaurus

next

Translate

启用搜索

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-config.html b/docs/zh-CN/next/site-config.html new file mode 100644 index 0000000000..1e99fdece6 --- /dev/null +++ b/docs/zh-CN/next/site-config.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

next

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/next/site-config/index.html b/docs/zh-CN/next/site-config/index.html new file mode 100644 index 0000000000..1e99fdece6 --- /dev/null +++ b/docs/zh-CN/next/site-config/index.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

next

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/next/site-creation.html b/docs/zh-CN/next/site-creation.html new file mode 100644 index 0000000000..95eddd7e15 --- /dev/null +++ b/docs/zh-CN/next/site-creation.html @@ -0,0 +1,179 @@ +创建你的站点 · Docusaurus

next

Translate

创建你的站点

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +

  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.

    +
    ---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
    2. +

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. +
+
+

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

+
+
    +
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. +
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. +
  3. Place assets, such as images, in the website/static/ directory.
    4. +
  4. Run the site to see the results of your changes.
    5. +
+
cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-creation/index.html b/docs/zh-CN/next/site-creation/index.html new file mode 100644 index 0000000000..95eddd7e15 --- /dev/null +++ b/docs/zh-CN/next/site-creation/index.html @@ -0,0 +1,179 @@ +创建你的站点 · Docusaurus

next

Translate

创建你的站点

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +

  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.

    +
    ---
+id: intro
+title: Getting Started
+---
+
+My new content here..
+
    2. +

  2. Add zero or more docs to the sidebars.json file so that your documentation is rendered in a sidebar, if you choose them to be.

    3. +
+
+

If you do not add your documentation to the sidebars.json file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.

+
+
    +
  1. Modify the website/siteConfig.js file to configure your site, following the comments included in the docs and the website/siteConfig.js to guide you.
    2. +
  2. Create any custom pages and/or customize the website/core/Footer.js file that provides the footer for your site.
    3. +
  3. Place assets, such as images, in the website/static/ directory.
    4. +
  4. Run the site to see the results of your changes.
    5. +
+
cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-preparation.html b/docs/zh-CN/next/site-preparation.html new file mode 100644 index 0000000000..3c9e920634 --- /dev/null +++ b/docs/zh-CN/next/site-preparation.html @@ -0,0 +1,147 @@ +建站准备 · Docusaurus

next

Translate

建站准备

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/next/site-preparation/index.html b/docs/zh-CN/next/site-preparation/index.html new file mode 100644 index 0000000000..3c9e920634 --- /dev/null +++ b/docs/zh-CN/next/site-preparation/index.html @@ -0,0 +1,147 @@ +建站准备 · Docusaurus

next

Translate

建站准备

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/next/translation.html b/docs/zh-CN/next/translation.html new file mode 100644 index 0000000000..9a9237f005 --- /dev/null +++ b/docs/zh-CN/next/translation.html @@ -0,0 +1,327 @@ +翻译和本地化 · Docusaurus

next

Translate

翻译和本地化

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/next/translation/index.html b/docs/zh-CN/next/translation/index.html new file mode 100644 index 0000000000..9a9237f005 --- /dev/null +++ b/docs/zh-CN/next/translation/index.html @@ -0,0 +1,327 @@ +翻译和本地化 · Docusaurus

next

Translate

翻译和本地化

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/next/versioning.html b/docs/zh-CN/next/versioning.html new file mode 100644 index 0000000000..2e83f52a29 --- /dev/null +++ b/docs/zh-CN/next/versioning.html @@ -0,0 +1,160 @@ +版本管理 · Docusaurus

next

Translate

版本管理

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/next/versioning/index.html b/docs/zh-CN/next/versioning/index.html new file mode 100644 index 0000000000..2e83f52a29 --- /dev/null +++ b/docs/zh-CN/next/versioning/index.html @@ -0,0 +1,160 @@ +版本管理 · Docusaurus

next

Translate

版本管理

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/publishing.html b/docs/zh-CN/publishing.html new file mode 100644 index 0000000000..a215896202 --- /dev/null +++ b/docs/zh-CN/publishing.html @@ -0,0 +1,322 @@ +Publishing your site · Docusaurus

1.8.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/publishing/index.html b/docs/zh-CN/publishing/index.html new file mode 100644 index 0000000000..a215896202 --- /dev/null +++ b/docs/zh-CN/publishing/index.html @@ -0,0 +1,322 @@ +Publishing your site · Docusaurus

1.8.0

Translate

Publishing your site

现在, 您应该有一个 站点, 并在本地运行 。 一旦您有了 自定义 的喜好, 就该发布它了。 Docusaurus 生成一个静态 HTML 网站, 它可以由您喜爱的 web 服务器或在线托管解决方案提供服务。

+

构建静态 HTML 页

+

要创建网站的静态生成, 请从 网站 目录中运行以下脚本:

+
yarn run build # 或是 `npm run build`
+
+

这将在 website 目录下生成一个 build 文件夹, 其中包含 website 目录下所有文档和其他页面中所含的 .html 文件。

+

构建静态 HTML 页

+

此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。

+
+

例如，Apache 和 Nginx 默认都从 /var/www/html 提供内容。 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。

+

当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 text/css。 以 nginx 为例，你需要在 nginx.conf 文件中设置 include /etc/nginx/mime.types;。 更多信息请参阅 this issue。

+
+

Hosting on a Service:

+ +

Using GitHub Pages

+

Docusaurus was designed to work really well with one of the most popular hosting solutions for open source projects: GitHub Pages.

+

Deploying to GitHub Pages

+
    +
  1. Docusaurus supports deploying as project pages or user/organization pages, your code repository does not even need to be public.
    2. +
+
+

Even if your repository is private, anything published to a gh-pages branch will be public.

+
+

Note: When you deploy as user/organization page, the publish script will deploy these sites to the root of the master branch of the username.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in another branch of the username.github.io repo (e.g., maybe call it source), or in another, separate repo (e.g. in the same as the documented source code).

+
    +
  1. You will need to modify the file website/siteConfig.js and add the required parameters.
    2. +
+ + + + + + + + + + +
Name说明
organizationNameThe GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
projectNameThe name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name in this case would be "docusaurus".
urlYour website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
baseUrlBase URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
+
const siteConfig = {
+  ...
+  url: 'https://__userName__.github.io', // Your website URL
+  baseUrl: '/testProject/',
+  projectName: 'testProject',
+  organizationName: 'userName'
+  ...
+}
+
+

In case you want to deploy as a user or organization site, specify the project name as <username>.github.io or <orgname>.github.io. E.g. If your GitHub username is "user42" then user42.github.io, or in the case of an organization name of "org123", it will be org123.github.io.

+

Note: Not setting the url and baseUrl of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images.

+
+

While we recommend setting the projectName and organizationName in siteConfig.js, you can also use environment variables ORGANIZATION_NAME and PROJECT_NAME.

+
+
    +
  1. Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
    2. +
+ + + + + + + +
Name说明
GIT_USERThe username for a GitHub account that has commit access to this repo. For your own repositories, this will usually be your own GitHub username. The specified GIT_USER must have push access to the repository specified in the combination of organizationName and projectName.
+

To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate.

+
GIT_USER=<GIT_USER> \
+  CURRENT_BRANCH=master \
+  USE_SSH=true \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+

There are also two optional parameters that are set as environment variables:

+ + + + + + + + +
Name说明
USE_SSHIf this is set to true, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set.
CURRENT_BRANCHThe branch that contains the latest docs changes that will be deployed. Usually, the branch will be master, but it could be any branch (default or otherwise) except for gh-pages. If nothing is set for this variable, then the current branch will be used.
+

If you run into issues related to SSH keys, visit GitHub's authentication documentation.

+

You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://username.github.io/projectName, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the gh-pages branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated CNAME file which can be configured via the cname siteConfig option.

+

We highly encourage reading through the GitHub Pages documentation to learn more about how this hosting solution works.

+

You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes.

+

However, you can automate the publishing process with continuous integration (CI).

+

Automating Deployments Using Continuous Integration

+

Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. In the following section we'll be covering how to do just that using CircleCI, a popular continuous integration service provider.

+

Using CircleCI 2.0

+

If you haven't done so already, you can setup CircleCI for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the publish-gh-pages script as part of the deployment step. You can follow the steps below to get that setup.

+
    +
  1. Ensure the GitHub account that will be set as the GIT_USER has write access to the repository that contains the documentation, by checking Settings | Collaborators & teams in the repository.
    2. +
  2. Log into GitHub as the GIT_USER.
    3. +
  3. Go to https://github.com/settings/tokens for the GIT_USER and generate a new personal access token, granting it full control of private repositories through the repository access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password.
    4. +
  4. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository.
    5. +
  5. Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
    6. +
  6. Create a .circleci directory and create a config.yml under that directory.
    7. +
  7. Copy the text below into .circleci/config.yml.
    8. +
+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

Make sure to replace all <....> in the command: sequence with appropriate values. For <GIT_USER>, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times <GIT_USER> and <GITHUB_USERNAME> will be the same.

+

DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 3.

+
+

If you want to use SSH for your GitHub repository connection, you can set USE_SSH=true. So the above command would look something like: cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.

+

Unlike when you run the publish-gh-pages script manually, when the script runs within the Circle environment, the value of CURRENT_BRANCH is already defined as an environment variable within CircleCI and will be picked up by the script automatically.

+
+

Now, whenever a new commit lands in master, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+
+

If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI instructions for adding a read/write deploy key.

+
+

Tips & Tricks

+

When initially deploying to a gh-pages branch using CircleCI, you may notice that some jobs triggered by commits to the gh-pages branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications).

+

You can work around this easily by:

+
    +
  • Setting the environment variable CUSTOM_COMMIT_MESSAGE flag to the publish-gh-pages command with the contents of [skip ci]. e.g.
    • +
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+  yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
+
    +
  • Alternatively you can work around this by creating a basic CircleCI config with the following contents:
    • +
+
# CircleCI 2.0 Config File
+# This config file will prevent tests from being run on the gh-pages branch.
+version: 2
+jobs:
+  build:
+    machine: true
+    branches:
+      ignore: gh-pages
+    steps:
+      - run: echo "Skipping tests on gh-pages branch"
+
+

Save this file as config.yml and place it in a .circleci directory inside your website/static directory.

+

Using Travis CI

+
    +
  1. Go to https://github.com/settings/tokens and generate a new personal access token
    2. +
  2. Using your GitHub account, add the Travis CI app to the repository you want to activate.
    3. +
  3. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
    4. +
  4. Create a new environment variable named GH_TOKEN with your newly generated token as its value, then GH_EMAIL (your email address) and GH_NAME (your GitHub username).
    5. +
  5. Create a .travis.yml on the root of your repository with below text.
    6. +
+
# .travis.yml
+language: node_js
+node_js:
+  - '8'
+branches:
+  only:
+    - master
+cache:
+  yarn: true
+script:
+  - git config --global user.name "${GH_NAME}"
+  - git config --global user.email "${GH_EMAIL}"
+  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
+  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+
+

Now, whenever a new commit lands in master, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the publish-gh-pages script.

+

Hosting on Netlify

+

Steps to configure your Docusaurus-powered site on Netlify.

+
    +

  1. Select New site from Git

    2. +

  2. Connect to your preferred Git provider.

    3. +

  3. Select the branch to deploy. Default is master

    4. +

  4. Configure your build steps:

    +
      +
    • For your build command enter: cd website; npm install; npm run build;
      • +
    • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
      • +
    5. +

  5. 单击 ** 部署站点 **

    6. +
+

You can also configure Netlify to rebuild on every commit to your repository, or only master branch commits.

+

Publishing to GitHub Enterprise

+

GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host.

+ + + + + + + +
Name说明
GITHUB_HOSTThe hostname for the GitHub enterprise server.
+

Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.

+
← 创建你的站点Docker →
\ No newline at end of file diff --git a/docs/zh-CN/search.html b/docs/zh-CN/search.html new file mode 100644 index 0000000000..9c2f027f6d --- /dev/null +++ b/docs/zh-CN/search.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.8.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/search/index.html b/docs/zh-CN/search/index.html new file mode 100644 index 0000000000..9c2f027f6d --- /dev/null +++ b/docs/zh-CN/search/index.html @@ -0,0 +1,158 @@ +Enabling Search · Docusaurus

1.8.0

Translate

Enabling Search

Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website need to be publicly available for this to work (ie. not behind a firewall). This service is free.

+

启用搜索框

+

Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.

+
const siteConfig = {
+  ...
+  algolia: {
+    apiKey: 'my-api-key',
+    indexName: 'my-index-name',
+    algoliaOptions: {} // Optional, if provided by Algolia
+  },
+  ...
+};
+
+

Extra Search Options

+

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 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 = {    
+  ...   
+  algolia: {    
+    ... 
+    algoliaOptions: {   
+      facetFilters: [ "language:LANGUAGE", "version:VERSION" ] 
+    }   
+  },    
+};  
+
+

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

+

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 between your internal and external links.

+
const siteConfig = {
+  ...
+  headerLinks: [
+    {...}
+    {...}
+    { search: true }
+    {...}
+    {...}
+  ],
+  ...
+};
+
+

Customizing the placeholder

+

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

+
const siteConfig = {    
+  ...   
+  algolia: {    
+    ... 
+    placeholder: 'Ask me something'
+  },    
+};  
+
+

Disabling the Search Bar

+

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

+

Also, if you have customized the location of the search bar in headerLinks, set search: false.

+
← 自定义-页面导航和边栏 →
\ No newline at end of file diff --git a/docs/zh-CN/site-config.html b/docs/zh-CN/site-config.html new file mode 100644 index 0000000000..098f7d2d09 --- /dev/null +++ b/docs/zh-CN/site-config.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.8.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/site-config/index.html b/docs/zh-CN/site-config/index.html new file mode 100644 index 0000000000..098f7d2d09 --- /dev/null +++ b/docs/zh-CN/site-config/index.html @@ -0,0 +1,388 @@ +siteConfig.js · Docusaurus

1.8.0

Translate

siteConfig.js

网站配置的很大一部分是通过编辑 siteConfig 文件来完成的。

+

用户展示

+

数组users用于存储要在网站上显示的所有项目或用户信息。 当前提供的示例 pages/en/index.js 和 pages/en/users.js 文件中有用到这个属性。 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。

+

目前数组users只用于示例文件index.js 和 users.js中。 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。

+

siteConfig 属性

+

siteConfig 对象包含了网站的大部分配置。

+

必填属性

+

baseUrl [string]

+

baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For urls that have no path, the baseUrl should be set to /. This field is related to the url field.

+

colors [object]

+

Color configurations for the site.

+
    +
  • primaryColor 标题导航栏和侧边栏的颜色。
    • +
  • secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
    • +
  • 还可以添加自定义颜色。 例如, 如果添加自定义样式时要用特定的 $myColor颜色, 则将 myColor 字段添加到 colors ，就可以轻松完成配置。
    • +
+

copyright [string]

+

The copyright string at footer of site and within feed

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in header navigation bar.

+

headerLinks [array]

+

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.

+

示例用法：

+
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 }
+],
+
+

organizationName [string]

+

GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted.

+

projectName [string]

+

Project name. This must match your GitHub repository project name (case-sensitive).

+

tagline [string]

+

Tagline for your website.

+

title [string]

+

Title for your website.

+

url [string]

+

URL for your website. This can also be considered the top-level hostname. For example, https://facebook.github.io is the url of https://facebook.github.io/metro/, and https://docusaurus.io is the url for https://docusaurus.io. This field is related to the baseUrl field.

+

可选属性

+

algolia [object]

+

Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (appId) is optional.

+
    +
  • apiKey - the Algolia provided API key for your search.
    • +
  • indexName - the Algolia provided index name for your search (usually this is the project name)
    • +
  • appId - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them.
    • +
+

blogSidebarCount [number]

+

Control the number of blog posts that show up in the sidebar. See the adding a blog docs for more information.

+

blogSidebarTitle [string]

+

Control the title of the blog sidebar. See the adding a blog docs for more information.

+

cleanUrl [string]

+

If true, allow URLs with no html extension. For example, a request to URL https://docusaurus.io/docs/installation will returns the same result as https://docusaurus.io/docs/installation.html.

+

cname [string]

+

The CNAME for your website. It will go into a CNAME file when your site is built.

+

customDocsPath [string]

+

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.

+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+

defaultVersionShown [string]

+

The default version for the site to be shown. If this is not set, the latest version will be shown.

+

docsUrl [string]

+

The base url for all docs file. Set this field to '' to remove the docs prefix of the documentation URL. If unset, it is defaulted to docs.

+

disableHeaderTitle [boolean]

+

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 [boolean]

+

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.

+

docsSideNavCollapsible [boolean]

+

Set this to true if you want to be able to expand/collapse the links and subcategories in the sidebar.

+

editUrl [string]

+

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.

+

enableUpdateBy [boolean]

+

An option to enable the docs showing the author who last updated the doc. Set to true to show a line at the bottom right corner of each doc page as Last updated by <Author Name>.

+

enableUpdateTime [boolean]

+

An option to enable the docs showing last update time. Set to true to show a line at the bottom right corner of each doc page as Last updated on <date>.

+

facebookAppId [string]

+

If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a Facebook application id.

+

facebookComments [boolean]

+

Set this to true if you want to enable Facebook comments at the bottom of your blog post. facebookAppId has to be also set.

+

facebookPixelId [string]

+

Facebook Pixel ID to track page views.

+

fonts [object]

+

Font-family CSS configuration for the site. If a font family is specified in siteConfig.js as $myFont, then adding a myFont key to an array in fonts will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter.

+

In the below example, we have two sets of font configurations, myFont and myOtherFont. Times New Roman is the preferred font in myFont. -apple-system is the preferred in myOtherFont.

+
fonts: {
+  myFont: [
+    'Times New Roman',
+    'Serif'
+  ],
+  myOtherFont: [
+    '-apple-system',
+    'system-ui'
+  ]
+},
+
+

The above fonts would be represented in your CSS file(s) as variables $myFont and $myOtherFont.

+
h1 {
+  font-family: $myFont;
+}
+
+

footerIcon [string]

+

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.

+

gaTrackingId [string]

+

Google Analytics tracking ID to track page views.

+

gaGtag [boolean]

+

Set this to true if you want to use global site tags (gtag.js) for Google analytics instead of analytics.js.

+

githubHost [string]

+

Hostname of your server. Useful if you are using GitHub Enterprise.

+

highlight

+

Syntax highlighting options:

+
{
+  // ...
+  highlight: {
+    // The name of the theme used by Highlight.js when highlighting code.
+    // You can find the list of supported themes here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+    theme: 'default',
+
+    // The particular version of Highlight.js to be used.
+    version: '9.12.0',
+
+    // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting.
+    hljs: function(highlightJsInstance) {
+      // do something here
+    },
+
+    // Default language.
+    // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here:
+    // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+    defaultLang: 'javascript',
+
+    // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored.
+    themeUrl: 'http://foo.bar/custom.css'
+  },
+}
+
+

manifest [string]

+

Path to your web app manifest (e.g., manifest.json). This will add a <link> tag to <head> with rel as "manifest" and href as the provided path.

+

markdownPlugins [array]

+

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.

+

noIndex [boolean]

+

Boolean. 如果为true， 这是通过header标签来完成的，因此只会影响文档和页面。 我们并不会尝试隐藏静态资源， 只能尽力而为， 因为恶意爬虫仍可以索引您的站点。

+

ogImage [string]

+

Local path to an Open Graph image (e.g., img/myImage.png). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported.

+

onPageNav [string]

+

If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option:

+ +

scripts [array]

+

Array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head.

+

separateCss [string]

+

Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

+

scrollToTop [boolean]

+

Set this to true if you want to enable the scroll to top button at the bottom of your site.

+

scrollToTopOptions [object]

+

Optional options configuration for the scroll to top button. You do not need to use this, even if you set scrollToTop to true; it just provides you more configuration control of the button. You can find more options here. By default, we set the zIndex option to 100.

+

stylesheets [array]

+

Array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head.

+

translationRecruitingLink [string]

+

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.

+

twitter [boolean]

+

Set this to true if you want a Twitter social button to appear at the bottom of your blog posts.

+

twitterUsername [string]

+

If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: docusaurus.

+

twitterImage [string]

+

Local path to your Twitter card image (e.g., img/myImage.png). This image will show up on the Twitter card when your site is shared on Twitter.

+

useEnglishUrl [string]

+

If you do not have translations enabled (e.g., by having a languages.js file), but still want a link of the form /docs/en/doc.html (with the en), set this to true.

+

users [array]

+

The users array mentioned earlier.

+

usePrism [array]

+

Array of languages to use Prism syntax highlighter. Refer to Using Prism as additional syntax highlighter. Set it to true to use Prism on all languages.

+

wrapPagesHTML [boolean]

+

Boolean flag to indicate whether html files in /pages should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being html fragments instead of complete pages. It inserts the contents of your html file with no extra processing. Defaults to false.

+

Users can also add their own custom fields if they wish to provide some data across different files.

+

Example siteConfig.js with many available 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://docusaurus.io',
+  baseUrl: '/',
+  // For github.io type URLS, you would combine the URL and baseUrl like:
+  // url: 'https://reasonml.github.io',
+  // baseUrl: '/reason-react/',
+  defaultVersionShown: '1.0.0',
+  organizationName: 'facebook',
+  projectName: 'docusaurus',
+  noIndex: false,
+  // For no header links in the top nav bar -> headerLinks: [],
+  headerLinks: [
+    {doc: 'doc1', label: 'Docs'},
+    {page: 'help', label: 'Help'},
+    {search: true},
+    {blog: true},
+  ],
+  headerIcon: 'img/docusaurus.svg',
+  favicon: 'img/favicon.png',
+  colors: {
+    primaryColor: '#2E8555',
+    secondaryColor: '#205C3B',
+  },
+  editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/',
+  // Users variable set above
+  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: 'UA-12345678-9',
+  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',
+    {
+      src:
+        'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
+      async: true,
+    },
+  ],
+  stylesheets: [
+    'https://docusaurus.io/style.css',
+    {
+      href: 'http://css.link',
+      type: 'text/css',
+    },
+  ],
+  facebookAppId: '1615782811974223',
+  facebookComments: true,
+  facebookPixelId: '352490515235776',
+  twitter: 'true',
+  twitterUsername: 'docusaurus',
+  twitterImage: 'img/docusaurus.png',
+  ogImage: 'img/docusaurus.png',
+  cleanUrl: true,
+  scrollToTop: true,
+  scrollToTopOptions: {
+    zIndex: 100,
+  },
+};
+
+module.exports = siteConfig;
+
+
← 页面和样式
\ No newline at end of file diff --git a/docs/zh-CN/site-creation.html b/docs/zh-CN/site-creation.html new file mode 100644 index 0000000000..83abef8237 --- /dev/null +++ b/docs/zh-CN/site-creation.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.8.0

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/site-config), following the comments included in the [docs](/docs/zh-CN/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/site-creation/index.html b/docs/zh-CN/site-creation/index.html new file mode 100644 index 0000000000..83abef8237 --- /dev/null +++ b/docs/zh-CN/site-creation/index.html @@ -0,0 +1,180 @@ +Creating your site · Docusaurus

1.8.0

Translate

Creating your site

Docusaurus 旨在让您的开源项目创建文档和网站变得更简单。

+

在 installation 和 preparation 之后，为您的文档创建基础站点的工作大部分已完成。

+

站点结构

+

您的网站结构如下所示：

+
root-directory
+├── docs
+└── website
+    ├── blog
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

假设你删除了由 初始化 脚本所创建的示例 .md 文件。

+
+

您所有的文档文件都应该以 markdown .md 文件置于 docs 文件夹下。 任何博客文章都应在 blog 文件夹下。

+
+

博客的文章格式应统一为 YYYY-MM-DD-your-file-name.md

+
+

创建您的基础站点

+

创建一个功能齐备的网站，你只需要以下几步：

+
    +
  1. 在 /docs 文件夹下添加您的 .md 文档文件，确保每个文件中都包含 header 的头信息。 The simplest header would be the following, where id is the link name (e.g., docs/intro.html) and the title is the webpage's title.
    2. +
+
    ---
+    id: intro
+    title: Getting Started
+    ---
+
+    My new content here..
+    ```
+
+1.  Add zero or more docs to the [`sidebars.json`](/docs/zh-CN/navigation#adding-docs-to-a-sidebar) file so that your documentation is rendered in a sidebar, if you choose them to be.
+
+> If you do not add your documentation to the `sidebars.json` file, the docs will be rendered, but they can only be linked to from other documentation and visited with the known URL.
+
+3.  Modify the `website/siteConfig.js` file to [configure your site](/docs/zh-CN/site-config), following the comments included in the [docs](/docs/zh-CN/site-config) and the `website/siteConfig.js` to guide you.
+1.  Create any [custom pages](/docs/zh-CN/custom-pages#customizing-your-site-footer) and/or [customize](/docs/zh-CN/custom-pages#customizing-your-site-footer) the `website/core/Footer.js` file that provides the footer for your site.
+1.  Place assets, such as images, in the `website/static/` directory.
+1.  Run the site to see the results of your changes.
+
+```bash
+cd website
+yarn run start # or `npm run start`
+# Navigate to http://localhost:3000
+
+

Special Customization

+

Docs Landing Page

+

If you prefer to have your landing page be straight to your documentation, you can do this through a redirect.

+
    +
  1. Remove the index.js file from the website/pages directory, if it exists.
    2. +
  2. Add a custom static index.html page in the website/static directory with the following contents:
    3. +
+
<!DOCTYPE HTML>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
+    <script type="text/javascript">
+      window.location.href = 'docs/id-of-doc-to-land-on.html';
+    </script>
+    <title>Your Site Title Here</title>
+  </head>
+  <body>
+    If you are not redirected automatically, follow this <a href="docs/id-of-doc-to-land-on.html">link</a>.
+  </body>
+</html>
+
+
+

You will get the id of the document to land on the .md metadata of that doc page.

+
+

Blog Only

+

You can also use Docusaurus to host your blog only.

+
← 建站准备发布你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/site-preparation.html b/docs/zh-CN/site-preparation.html new file mode 100644 index 0000000000..1644a51390 --- /dev/null +++ b/docs/zh-CN/site-preparation.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.8.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/site-preparation/index.html b/docs/zh-CN/site-preparation/index.html new file mode 100644 index 0000000000..1644a51390 --- /dev/null +++ b/docs/zh-CN/site-preparation/index.html @@ -0,0 +1,147 @@ +Site Preparation · Docusaurus

1.8.0

Translate

Site Preparation

在 安装 Docusaurus之后, 您现在有了一个特定网站的可用骨架。 下面将讨论 Docusaurus 结构的其余部分, 以便您准备建站。

+

目录结构

+

正如安装 Docusaurus后所示, 初始化脚本创建了一个类似于以下内容的目录结构:

+
root-directory
+├── docs-examples-from-docusaurus
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog-examples-from-docusaurus
+    │   ├── 2016-03-11-blog-post.md
+    │   ├── 2017-04-10-blog-post-two.md
+    │   ├── 2017-09-25-testing-rss.md
+    │   ├── 2017-09-26-adding-rss.md
+    │   └── 2017-10-24-new-version-1.0.0.md
+    ├── core
+    │   └── Footer.js
+    ├── package.json
+    ├── pages
+    ├── sidebars.json
+    ├── siteConfig.js
+    └── static
+
+
+

在 verified the installation 步骤后，你可能已经重命名了博客（website/blog-examples-from-docusaurus 重名为 website/blog）与文档文件夹（docs-examples-from-docusaurus 重名为 docs）。

+
+

目录介绍

+
    +
  • 文档源文件：包含可编写的 Markdown 示例文件的文件夹 docs-examples-from-docusaurus。
    • +
  • 博客：包含了可编写的 Markdown 示例文章的文件夹 website/blog-examples-from-docusaurus。
    • +
  • 页面：包含示例网站顶级页面的文件夹 website/pages。
    • +
  • 静态资源与图片：包含供网站使用的静态资源文件夹 website/static。
    • +
+

关键文件

+
    +
  • 页脚：website/core/Footer.js 文件是一个 React 组件，用于生成 Docusaurus 站点的页脚，它可以由用户定制。
    • +
  • 配置文件：website/siteConfig.js 文件是 Docusaurus 的主配置文件。
    • +
  • 工具栏：sidebars.json 文件包含文档文件的结构与排序。
    • +
+

准备说明

+

您不能删除 website/siteConfig.js 和 website/core/Footer.js 文件, 但可以按您的意愿编辑它们。 The value of the customDocsPath key in website/siteConfig.js can be modified if you wish to use a different directory name or path. The website directory can also be renamed to anything you want it to be.

+

However, you should keep the website/pages and website/static directories. You may change the content inside them as you wish. 在 website/pages 目录，你至少应该有一个 en/index.js 或 en/index.html 以及在website/static里有一个图片作为您的页眉图标(header icon) 。

+
← 安装创建你的站点 →
\ No newline at end of file diff --git a/docs/zh-CN/translation.html b/docs/zh-CN/translation.html new file mode 100644 index 0000000000..8ef8ddce52 --- /dev/null +++ b/docs/zh-CN/translation.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.8.0

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/translation/index.html b/docs/zh-CN/translation/index.html new file mode 100644 index 0000000000..8ef8ddce52 --- /dev/null +++ b/docs/zh-CN/translation/index.html @@ -0,0 +1,327 @@ +Translations & Localization · Docusaurus

1.8.0

Translate

Translations & Localization

Docusaurus 借助 Crowdin 可以非常简单的实现翻译功能。 用英文写的文档文件会被上传到 Crowdin, 供社区内的用户翻译。 用英文字符串编写的顶级网页可以通过在<translate>标记中打包任何要翻译的字符串来进行翻译。 其他标题和标签也会被发现和正确翻译。

+

Docusaurus 翻译配置

+

To generate example files for translations with Docusaurus, run the examples script with the command line argument translations:

+
npm run examples translations
+
+

或

+
yarn examples translations
+
+

这会创建以下文件:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • pages/en/help-with-translations.js 文件包括由 examples 脚本生成的相同的初学者帮助页, 但是现在也包括翻译标记。
    • +
+
+

Generally, you will use help-with-translations.js as a guide to enable translations in your other pages, but not actually commit the file to your repo (i.e., you can delete it). However, if you want a Help page, and you currently do not have one, you can rename this file to help.js and use it as a starting point.

+
+
    +

  • 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.

    • +
+

翻译现有文档

+

Your documentation files (e.g., the .md files that live in your docs directory) do not need to be changed or moved to support translations. They will be uploaded to Crowdin to be translated directly.

+

在页面上启用翻译

+

页面允许您自定义页面设计和特定内容, 就像一个自定义索引页或帮助页。

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

把你需要翻译的字符串打包到 <translate> 标签中，然后添加 require 声明到文件的顶部。

+
...
+const translate = require('../../server/translate.js').translate;
+...
+<h2>
+  <translate>This header will be translated</translate>
+</h2>
+...
+
+

您还可以提交一个可选说明属性, 以便为翻译人员提供有关如何翻译字符串的更多详情:

+
<p>
+  <translate desc="flower, not verb">Rose</translate>
+<p>
+
+
+

The <translate> tag generally works well on pure strings. If you have a string like "Docusaurus currently provides support to help your website use translations", wrapping the <translation> tag around that entire string will cause issues because of the markdown linking, etc. Your options are to not translate those strings, or spread a bunch of <translate> tags amongst the pure substrings of that string.

+
+

收集字符串以进行转换

+

有本地化页面的字符串必须提取出并提供给Crowdin。

+

Add the following script to your website/package.json file, if it does not exist already:

+
{
+  ...
+  "scripts": {
+    "write-translations": "docusaurus-write-translations"
+  },
+  ...
+}
+
+

运行该脚本将生成一个 website/i18n/en.json 文件, 其中包含将从英语翻译成其他语言的所有字符串。

+

该脚本将包含在以下位置的文本:

+
    +
  • title 和 sidebar_label 在markdown标题中的字符串
    • +
  • sidebars. json 中的种类名称
    • +
  • 在siteConfig.js中的标语
    • +
  • siteConfig 里的标题链接 label 字符串
    • +
  • 在 pages 中的任何 . js 文件中, 在 < translate > 标记中包装的字符串
    • +
+

Custom Translation Strings

+

If you want to add additional custom translation strings, or override any of the strings that get produced by the script that creates the website/i18n/en.json file, you can add a website/data/custom-translation-strings.json file. The file should have form of:

+
{
+  "localized-strings": {
+    "docs": {
+      "id": {
+        "title": "string1",
+        "sidebar_label": "string2"
+      },
+      "version-0.0.1-id": {
+        "title": "string3",
+        "sidebar_label": "string4"
+      }
+    }
+  },
+  "pages-strings" : {
+    "id3": "string3",
+    "id4": "string4"
+  }
+}
+
+

where localized-strings represent strings in your documentation content and pages-strings represents metadata in your documentation (e.g., title, links, etc).

+

Here is an example:

+
{
+  "_comment": "This file is used to provide custom strings for translations, including overriding defaults",
+  "localized-strings": {
+    "translation": "Translations and Localization"
+  },
+  "pages-strings" : {
+        "Help Translate|recruit community translators for your project": "Help Us Translate"
+  }
+}
+
+

See the generated website/i18n/en.json for an example.

+

字符串是怎么转换的

+

Docusaurus本身并不会做任何翻译工作 相反, 它集成了 crowdin 来上传需翻译的文字, 然后从 crowdin 下载适当的翻译文件。

+

Docusaurus怎样使用字符串翻译

+

这部分提供Docusaurus中的翻译是怎么工作的上下文

+

字符串

+

Docusaurus站点有许多需要本地化处理的字符串。 但是, 维护一个通过站点使用的字符串列表可能会很辛苦。 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. We suggest that you deselect and do not include "English" as a translatable language to prevent the creation of en-US localization files as this can lead to confusion.

+
+

Ensure in your Crowdin settings, in the Translations section, that "Duplicate Strings" are set to "Hide - all duplicates will share the same translation". This setting will ensure that identical strings between versions share a single translation.

+
+

Your project will need a crowdin.yaml file generated. If you ran yarn examples translations or npm run examples translations, this file was created for you on the same level as your website directory.

+
+

You will need to install the crowdin command line interface. Please follow the installation directions.

+
+

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
+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-CN'
+        'zh-TW': 'zh-TW'
+
+

You can go here to learn more about customizing your crowdin.yaml file.

+

Setup the Crowdin Scripts

+

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": {
+  "crowdin-upload": "crowdin --config ../crowdin.yaml upload sources --auto-update -b master",
+  "crowdin-download": "crowdin --config ../crowdin.yaml download -b master"
+},
+
+

Manual File Sync

+

You will always want to upload your markdown files and translatable strings first and the download the translations section. So run the commands in this order:

+
CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-upload
+CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY=YOUR_CROWDIN_API_KEY yarn run crowdin-download
+
+
+

YOUR_CROWDIN_PROJECT_ID is the name of your Crowdin project. e.g., for https://crowdin.com/project/docusaurus/, that variable would be set to docusaurus. YOUR_CROWDIN_API_KEY is a unique key that is like a password. You can find it in the API tab of your Crowdin project's Settings.

+

These commands require having an environment variable set with your Crowdin project id and api key (CROWDIN_PROJECT_ID, CROWDIN_API_KEY). You can preface them inline as done 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 environment variables to something unique (CROWDIN_PROJECTNAME_PROJECT_ID, CROWDIN_PROJECTNAME_API_KEY).

+

Since the files are generated, you do not need to have any files in your website/i18n or website/translated_docs directory as part of your repo. So you can can add website/i18n/* and website/translated_docs to your .gitignore file.

+
+

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 .circleci/config.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 .circleci/config.yml file:

+
# If you only want circle to run on direct commits to master, you can uncomment this out
+# and uncomment the filters: *filter-only-master down below too
+#
+# aliases:
+#  - &filter-only-master
+#    branches:
+#      only:
+#        - master
+
+version: 2
+jobs:
+  deploy-website:
+    docker:
+      # specify the version you desire here
+
+      - image: circleci/node:8.11.1
+
+    steps:
+
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
+            git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
+            git config --global user.name "<YOUR_NAME>"
+            echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
+            # install Docusaurus and generate file of English strings
+            - cd website && yarn install && yarn 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=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+
+      - deploy-website:
+#         filters: *filter-only-master
+
+

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

+

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}/.

+
← 导航和边栏版本管理 →
\ No newline at end of file diff --git a/docs/zh-CN/versioning.html b/docs/zh-CN/versioning.html new file mode 100644 index 0000000000..4633c0c1a5 --- /dev/null +++ b/docs/zh-CN/versioning.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.8.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/docs/zh-CN/versioning/index.html b/docs/zh-CN/versioning/index.html new file mode 100644 index 0000000000..4633c0c1a5 --- /dev/null +++ b/docs/zh-CN/versioning/index.html @@ -0,0 +1,160 @@ +Versioning · Docusaurus

1.8.0

Translate

Versioning

You can use the version script to cut a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.

+

如何创建新版本

+

Run the following script to generate a starter versions page listing all the site 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
+
+

This will preserve all documents currently in the docs directory 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL docs/next/doc1.html. Documents from the latest version use the URL docs/doc1.html.

+

Running the script again with yarn run version 2.0.0 will create a version 2.0.0, making version 2.0.0 the most recent set of documentation. Documents from version 1.0.0 will use the URL docs/1.0.0/doc1.html while 2.0.0 will use docs/doc1.html.

+

This table below summarizes Docusaurus versioning at a glance:

+ + + + + + + + + + +
VersionTagURL
1.0.01.0.0docs/1.0.0/doc1.html
1.0.11.0.1docs/1.0.1/doc1.html
2.0.0currentdocs/doc1.html
master branchnextdocs/next/doc1.html
+

Versioning Patterns

+

You can create version numbers in whatever format you wish, and a new version can be created with any version number as long as it does not match an existing version. Version ordering is determined by the order in which versions are created, independently of how they are numbered.

+

Storing Files for Each Version

+

Versioned documents are placed into website/versioned_docs/version-${version}, where ${version} is the version number you supplied the version script.

+

The markdown header for each versioned doc is altered by renaming the id front matter field to original_id, then using "version-${version}-${original_id}" as the value for the actual id field.

+

Versioned sidebars are copied into website/versioned_sidebars and are named as version-${version}-sidebars.json.

+

A website/versions.json file is created the first time you cut a version and is used by Docusaurus to detect what versions exist. Each time a new version is added, it gets added to the versions.json file.

+

If you wish to change the documentation for a past version, you can access the files for that respective version.

+

Fallback Functionality

+

Only files in the docs directory and sidebar files that differ from those of the latest version will get copied each time a new version is specified. If there is no change across versions, Docusaurus will use the file from the latest version with that file.

+

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 directory. 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.,

+
yarn 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 directory translated_docs/${language}/version-${version}/. For more information, check out the translations guide.

+
← 翻译和本地化CLI 命令 →
\ No newline at end of file diff --git a/tr/about-slash.html b/tr/about-slash.html index 67cf5c466b..2c5b441ff2 100644 --- a/tr/about-slash.html +++ b/tr/about-slash.html @@ -1,4 +1,4 @@ -About Slash · Docusaurus

1.8.0

关于斜线

Docusaurus

Slash is the official mascot of Docusaurus. You will find different variations of her throughout the website, whether she is moving fast on her scooter or writing documentation at her standing desk. At Facebook, we have actual Slash plushies -- and you never know, you may see these plushies at various events and conferences in the future.

斜线诞生

Birth of Slash

The team sat in a conference room trying to come up with a name for the project. Dinosaurs became a theme, finally landing on Docusaurus, combining documentation with those many dinosaurs that end in "saurus". Of course, we needed a logo for our new project. Eric sat down and designed a logo that was quite beyond the norm of our normal open source project logos, but yet was just so awesome, we had to use it. We needed a name for this cute Docusaur. "Marky" for markdown? "Docky" for documentation? No, "Slash" for the normal way someone starts code documentation in many programming languages // or /* or ///. And Slash was born.