diff --git a/docs/en/1.10.x/doc-markdown.html b/docs/en/1.10.x/doc-markdown.html index c7f2860aa8..cea34086e2 100644 --- a/docs/en/1.10.x/doc-markdown.html +++ b/docs/en/1.10.x/doc-markdown.html @@ -162,10 +162,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.10.x/doc-markdown/index.html b/docs/en/1.10.x/doc-markdown/index.html index c7f2860aa8..cea34086e2 100644 --- a/docs/en/1.10.x/doc-markdown/index.html +++ b/docs/en/1.10.x/doc-markdown/index.html @@ -162,10 +162,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.11.x/doc-markdown.html b/docs/en/1.11.x/doc-markdown.html index 44b26f2f75..3ab492cb38 100644 --- a/docs/en/1.11.x/doc-markdown.html +++ b/docs/en/1.11.x/doc-markdown.html @@ -162,10 +162,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.11.x/doc-markdown/index.html b/docs/en/1.11.x/doc-markdown/index.html index 44b26f2f75..3ab492cb38 100644 --- a/docs/en/1.11.x/doc-markdown/index.html +++ b/docs/en/1.11.x/doc-markdown/index.html @@ -162,10 +162,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.9.x/doc-markdown.html b/docs/en/1.9.x/doc-markdown.html index ae0edd34cf..4781a50dcd 100644 --- a/docs/en/1.9.x/doc-markdown.html +++ b/docs/en/1.9.x/doc-markdown.html @@ -162,10 +162,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.9.x/doc-markdown/index.html b/docs/en/1.9.x/doc-markdown/index.html index ae0edd34cf..4781a50dcd 100644 --- a/docs/en/1.9.x/doc-markdown/index.html +++ b/docs/en/1.9.x/doc-markdown/index.html @@ -162,10 +162,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 0ba60a2415..b344532a94 100644 --- a/docs/en/doc-markdown.html +++ b/docs/en/doc-markdown.html @@ -162,10 +162,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 0ba60a2415..b344532a94 100644 --- a/docs/en/doc-markdown/index.html +++ b/docs/en/doc-markdown/index.html @@ -162,10 +162,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/next/tutorial-setup.html b/docs/en/next/tutorial-setup.html index f13f68866f..33726cae7a 100644 --- a/docs/en/next/tutorial-setup.html +++ b/docs/en/next/tutorial-setup.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/en/next/tutorial-setup/index.html b/docs/en/next/tutorial-setup/index.html index f13f68866f..33726cae7a 100644 --- a/docs/en/next/tutorial-setup/index.html +++ b/docs/en/next/tutorial-setup/index.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/fr/1.10.x/doc-markdown.html b/docs/fr/1.10.x/doc-markdown.html index b28603d4d4..a94261d96a 100644 --- a/docs/fr/1.10.x/doc-markdown.html +++ b/docs/fr/1.10.x/doc-markdown.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/1.10.x/doc-markdown/index.html b/docs/fr/1.10.x/doc-markdown/index.html index b28603d4d4..a94261d96a 100644 --- a/docs/fr/1.10.x/doc-markdown/index.html +++ b/docs/fr/1.10.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/1.11.x/doc-markdown.html b/docs/fr/1.11.x/doc-markdown.html index e2fc724d98..d48ca313f0 100644 --- a/docs/fr/1.11.x/doc-markdown.html +++ b/docs/fr/1.11.x/doc-markdown.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/1.11.x/doc-markdown/index.html b/docs/fr/1.11.x/doc-markdown/index.html index e2fc724d98..d48ca313f0 100644 --- a/docs/fr/1.11.x/doc-markdown/index.html +++ b/docs/fr/1.11.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/1.9.x/doc-markdown.html b/docs/fr/1.9.x/doc-markdown.html index d713a15975..7dad680e79 100644 --- a/docs/fr/1.9.x/doc-markdown.html +++ b/docs/fr/1.9.x/doc-markdown.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/1.9.x/doc-markdown/index.html b/docs/fr/1.9.x/doc-markdown/index.html index d713a15975..7dad680e79 100644 --- a/docs/fr/1.9.x/doc-markdown/index.html +++ b/docs/fr/1.9.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/doc-markdown.html b/docs/fr/doc-markdown.html index 4c63ea4fa4..ba9c342e83 100644 --- a/docs/fr/doc-markdown.html +++ b/docs/fr/doc-markdown.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/doc-markdown/index.html b/docs/fr/doc-markdown/index.html index 4c63ea4fa4..ba9c342e83 100644 --- a/docs/fr/doc-markdown/index.html +++ b/docs/fr/doc-markdown/index.html @@ -162,10 +162,10 @@ Texte décrivant ma fonction

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.

Coloration syntaxique

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/fr/next/tutorial-setup.html b/docs/fr/next/tutorial-setup.html index bc666399a5..20e57440a6 100644 --- a/docs/fr/next/tutorial-setup.html +++ b/docs/fr/next/tutorial-setup.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/fr/next/tutorial-setup/index.html b/docs/fr/next/tutorial-setup/index.html index bc666399a5..20e57440a6 100644 --- a/docs/fr/next/tutorial-setup/index.html +++ b/docs/fr/next/tutorial-setup/index.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/ko/1.10.x/doc-markdown.html b/docs/ko/1.10.x/doc-markdown.html index 44a6d577af..11dc9299e0 100644 --- a/docs/ko/1.10.x/doc-markdown.html +++ b/docs/ko/1.10.x/doc-markdown.html @@ -162,10 +162,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/ko/1.10.x/doc-markdown/index.html b/docs/ko/1.10.x/doc-markdown/index.html index 44a6d577af..11dc9299e0 100644 --- a/docs/ko/1.10.x/doc-markdown/index.html +++ b/docs/ko/1.10.x/doc-markdown/index.html @@ -162,10 +162,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/ko/1.11.x/doc-markdown.html b/docs/ko/1.11.x/doc-markdown.html index 709b569335..ce37c302f9 100644 --- a/docs/ko/1.11.x/doc-markdown.html +++ b/docs/ko/1.11.x/doc-markdown.html @@ -162,10 +162,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/ko/1.11.x/doc-markdown/index.html b/docs/ko/1.11.x/doc-markdown/index.html index 709b569335..ce37c302f9 100644 --- a/docs/ko/1.11.x/doc-markdown/index.html +++ b/docs/ko/1.11.x/doc-markdown/index.html @@ -162,10 +162,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/ko/1.9.x/doc-markdown.html b/docs/ko/1.9.x/doc-markdown.html index ad21e0f7af..207fd73497 100644 --- a/docs/ko/1.9.x/doc-markdown.html +++ b/docs/ko/1.9.x/doc-markdown.html @@ -162,10 +162,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/ko/1.9.x/doc-markdown/index.html b/docs/ko/1.9.x/doc-markdown/index.html index ad21e0f7af..207fd73497 100644 --- a/docs/ko/1.9.x/doc-markdown/index.html +++ b/docs/ko/1.9.x/doc-markdown/index.html @@ -162,10 +162,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/ko/doc-markdown.html b/docs/ko/doc-markdown.html index dff6f7a04e..f63c2db388 100644 --- a/docs/ko/doc-markdown.html +++ b/docs/ko/doc-markdown.html @@ -162,10 +162,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/ko/doc-markdown/index.html b/docs/ko/doc-markdown/index.html index dff6f7a04e..f63c2db388 100644 --- a/docs/ko/doc-markdown/index.html +++ b/docs/ko/doc-markdown/index.html @@ -162,10 +162,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/ko/next/tutorial-setup.html b/docs/ko/next/tutorial-setup.html index ffa23f829e..20913a9a3b 100644 --- a/docs/ko/next/tutorial-setup.html +++ b/docs/ko/next/tutorial-setup.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/ko/next/tutorial-setup/index.html b/docs/ko/next/tutorial-setup/index.html index ffa23f829e..20913a9a3b 100644 --- a/docs/ko/next/tutorial-setup/index.html +++ b/docs/ko/next/tutorial-setup/index.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/pt-BR/1.10.x/doc-markdown.html b/docs/pt-BR/1.10.x/doc-markdown.html index d47136d8bc..4059288f55 100644 --- a/docs/pt-BR/1.10.x/doc-markdown.html +++ b/docs/pt-BR/1.10.x/doc-markdown.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/1.10.x/doc-markdown/index.html b/docs/pt-BR/1.10.x/doc-markdown/index.html index d47136d8bc..4059288f55 100644 --- a/docs/pt-BR/1.10.x/doc-markdown/index.html +++ b/docs/pt-BR/1.10.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/1.11.x/doc-markdown.html b/docs/pt-BR/1.11.x/doc-markdown.html index fbaf43ee97..8e67b74d92 100644 --- a/docs/pt-BR/1.11.x/doc-markdown.html +++ b/docs/pt-BR/1.11.x/doc-markdown.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/1.11.x/doc-markdown/index.html b/docs/pt-BR/1.11.x/doc-markdown/index.html index fbaf43ee97..8e67b74d92 100644 --- a/docs/pt-BR/1.11.x/doc-markdown/index.html +++ b/docs/pt-BR/1.11.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/1.9.x/doc-markdown.html b/docs/pt-BR/1.9.x/doc-markdown.html index dbd8b66118..c254469838 100644 --- a/docs/pt-BR/1.9.x/doc-markdown.html +++ b/docs/pt-BR/1.9.x/doc-markdown.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/1.9.x/doc-markdown/index.html b/docs/pt-BR/1.9.x/doc-markdown/index.html index dbd8b66118..c254469838 100644 --- a/docs/pt-BR/1.9.x/doc-markdown/index.html +++ b/docs/pt-BR/1.9.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/doc-markdown.html b/docs/pt-BR/doc-markdown.html index 15214c87aa..0344248563 100644 --- a/docs/pt-BR/doc-markdown.html +++ b/docs/pt-BR/doc-markdown.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/doc-markdown/index.html b/docs/pt-BR/doc-markdown/index.html index 15214c87aa..0344248563 100644 --- a/docs/pt-BR/doc-markdown/index.html +++ b/docs/pt-BR/doc-markdown/index.html @@ -162,10 +162,10 @@ Texto descrevendo a função

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.

Realce de sintaxe

O realce de sintaxe é ativado por padrão em blocos de código cercados. A linguagem já deve ser detectada automaticamente, porém às vezes você pode obter melhores resultados ao se especificar ela. Você pode fazer isso usando uma string informativa, logo após os três acentos graves (também conhecidos como backticks) de abertura. O seguinte exemplo em JavaScript...

diff --git a/docs/pt-BR/next/tutorial-setup.html b/docs/pt-BR/next/tutorial-setup.html index 204c94b587..220ecb3354 100644 --- a/docs/pt-BR/next/tutorial-setup.html +++ b/docs/pt-BR/next/tutorial-setup.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/pt-BR/next/tutorial-setup/index.html b/docs/pt-BR/next/tutorial-setup/index.html index 204c94b587..220ecb3354 100644 --- a/docs/pt-BR/next/tutorial-setup/index.html +++ b/docs/pt-BR/next/tutorial-setup/index.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/ro/1.10.x/adding-blog.html b/docs/ro/1.10.x/adding-blog.html new file mode 100644 index 0000000000..a5e7c196b2 --- /dev/null +++ b/docs/ro/1.10.x/adding-blog.html @@ -0,0 +1,202 @@ +Adding a Blog · Docusaurus

1.10.x

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

Spre exemplu, la siteweb/blog/2017-08-18-Introducând-Docusaurus.md:

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

Opțiuni Header

+

Singurul câmp necesar este titlu; cu toate acestea, vă oferim opțiuni să adăugați informații despre autor la post-area ta de blog deasemenea.

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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/ro/1.10.x/adding-blog/index.html b/docs/ro/1.10.x/adding-blog/index.html new file mode 100644 index 0000000000..a5e7c196b2 --- /dev/null +++ b/docs/ro/1.10.x/adding-blog/index.html @@ -0,0 +1,202 @@ +Adding a Blog · Docusaurus

1.10.x

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

Spre exemplu, la siteweb/blog/2017-08-18-Introducând-Docusaurus.md:

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

Opțiuni Header

+

Singurul câmp necesar este titlu; cu toate acestea, vă oferim opțiuni să adăugați informații despre autor la post-area ta de blog deasemenea.

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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/ro/1.10.x/api-pages.html b/docs/ro/1.10.x/api-pages.html new file mode 100644 index 0000000000..d121b568f9 --- /dev/null +++ b/docs/ro/1.10.x/api-pages.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.10.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/1.10.x/api-pages/index.html b/docs/ro/1.10.x/api-pages/index.html new file mode 100644 index 0000000000..d121b568f9 --- /dev/null +++ b/docs/ro/1.10.x/api-pages/index.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.10.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/1.10.x/commands.html b/docs/ro/1.10.x/commands.html new file mode 100644 index 0000000000..6993105826 --- /dev/null +++ b/docs/ro/1.10.x/commands.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

1.10.x

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/1.10.x/commands/index.html b/docs/ro/1.10.x/commands/index.html new file mode 100644 index 0000000000..6993105826 --- /dev/null +++ b/docs/ro/1.10.x/commands/index.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

1.10.x

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/1.10.x/custom-pages.html b/docs/ro/1.10.x/custom-pages.html new file mode 100644 index 0000000000..94428d7c2b --- /dev/null +++ b/docs/ro/1.10.x/custom-pages.html @@ -0,0 +1,154 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/1.10.x/custom-pages/index.html b/docs/ro/1.10.x/custom-pages/index.html new file mode 100644 index 0000000000..94428d7c2b --- /dev/null +++ b/docs/ro/1.10.x/custom-pages/index.html @@ -0,0 +1,154 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/1.10.x/doc-markdown.html b/docs/ro/1.10.x/doc-markdown.html new file mode 100644 index 0000000000..9df0ab7171 --- /dev/null +++ b/docs/ro/1.10.x/doc-markdown.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.10.x

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/1.10.x/doc-markdown/index.html b/docs/ro/1.10.x/doc-markdown/index.html new file mode 100644 index 0000000000..9df0ab7171 --- /dev/null +++ b/docs/ro/1.10.x/doc-markdown/index.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.10.x

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/1.10.x/docker.html b/docs/ro/1.10.x/docker.html new file mode 100644 index 0000000000..421b47fd32 --- /dev/null +++ b/docs/ro/1.10.x/docker.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.10.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/1.10.x/docker/index.html b/docs/ro/1.10.x/docker/index.html new file mode 100644 index 0000000000..421b47fd32 --- /dev/null +++ b/docs/ro/1.10.x/docker/index.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.10.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/1.10.x/installation.html b/docs/ro/1.10.x/installation.html new file mode 100644 index 0000000000..7732b4bc99 --- /dev/null +++ b/docs/ro/1.10.x/installation.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/1.10.x/installation/index.html b/docs/ro/1.10.x/installation/index.html new file mode 100644 index 0000000000..7732b4bc99 --- /dev/null +++ b/docs/ro/1.10.x/installation/index.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/1.10.x/navigation.html b/docs/ro/1.10.x/navigation.html new file mode 100644 index 0000000000..0435e65045 --- /dev/null +++ b/docs/ro/1.10.x/navigation.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/1.10.x/navigation/index.html b/docs/ro/1.10.x/navigation/index.html new file mode 100644 index 0000000000..0435e65045 --- /dev/null +++ b/docs/ro/1.10.x/navigation/index.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/1.10.x/publishing.html b/docs/ro/1.10.x/publishing.html new file mode 100644 index 0000000000..0e8dbe39f3 --- /dev/null +++ b/docs/ro/1.10.x/publishing.html @@ -0,0 +1,345 @@ +Publishing your site · Docusaurus

1.10.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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/ro/1.10.x/publishing/index.html b/docs/ro/1.10.x/publishing/index.html new file mode 100644 index 0000000000..0e8dbe39f3 --- /dev/null +++ b/docs/ro/1.10.x/publishing/index.html @@ -0,0 +1,345 @@ +Publishing your site · Docusaurus

1.10.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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/ro/1.10.x/search.html b/docs/ro/1.10.x/search.html new file mode 100644 index 0000000000..ccba0eadcd --- /dev/null +++ b/docs/ro/1.10.x/search.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.10.x

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/1.10.x/search/index.html b/docs/ro/1.10.x/search/index.html new file mode 100644 index 0000000000..ccba0eadcd --- /dev/null +++ b/docs/ro/1.10.x/search/index.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.10.x

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/1.10.x/site-config.html b/docs/ro/1.10.x/site-config.html new file mode 100644 index 0000000000..c03f30fcbb --- /dev/null +++ b/docs/ro/1.10.x/site-config.html @@ -0,0 +1,394 @@ +siteConfig.js · Docusaurus

1.10.x

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/1.10.x/site-config/index.html b/docs/ro/1.10.x/site-config/index.html new file mode 100644 index 0000000000..c03f30fcbb --- /dev/null +++ b/docs/ro/1.10.x/site-config/index.html @@ -0,0 +1,394 @@ +siteConfig.js · Docusaurus

1.10.x

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/1.10.x/site-creation.html b/docs/ro/1.10.x/site-creation.html new file mode 100644 index 0000000000..cc8667ce74 --- /dev/null +++ b/docs/ro/1.10.x/site-creation.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/1.10.x/site-creation/index.html b/docs/ro/1.10.x/site-creation/index.html new file mode 100644 index 0000000000..cc8667ce74 --- /dev/null +++ b/docs/ro/1.10.x/site-creation/index.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/1.10.x/site-preparation.html b/docs/ro/1.10.x/site-preparation.html new file mode 100644 index 0000000000..9478461515 --- /dev/null +++ b/docs/ro/1.10.x/site-preparation.html @@ -0,0 +1,151 @@ +Site Preparation · Docusaurus

1.10.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

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

1.10.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

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

1.10.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

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

1.10.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-create-new-site.html b/docs/ro/1.10.x/tutorial-create-new-site.html new file mode 100644 index 0000000000..5928c38f65 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-create-new-site.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.10.x

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-create-new-site/index.html b/docs/ro/1.10.x/tutorial-create-new-site/index.html new file mode 100644 index 0000000000..5928c38f65 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-create-new-site/index.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.10.x

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-create-pages.html b/docs/ro/1.10.x/tutorial-create-pages.html new file mode 100644 index 0000000000..972ebb7065 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-create-pages.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.10.x

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-create-pages/index.html b/docs/ro/1.10.x/tutorial-create-pages/index.html new file mode 100644 index 0000000000..972ebb7065 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-create-pages/index.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.10.x

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-publish-site.html b/docs/ro/1.10.x/tutorial-publish-site.html new file mode 100644 index 0000000000..91b1b27944 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-publish-site.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.10.x

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-publish-site/index.html b/docs/ro/1.10.x/tutorial-publish-site/index.html new file mode 100644 index 0000000000..91b1b27944 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-publish-site/index.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.10.x

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-setup.html b/docs/ro/1.10.x/tutorial-setup.html new file mode 100644 index 0000000000..239c2accc9 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-setup.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.10.x

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-setup/index.html b/docs/ro/1.10.x/tutorial-setup/index.html new file mode 100644 index 0000000000..239c2accc9 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-setup/index.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.10.x

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-version.html b/docs/ro/1.10.x/tutorial-version.html new file mode 100644 index 0000000000..a7a64b5289 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-version.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.10.x

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/1.10.x/tutorial-version/index.html b/docs/ro/1.10.x/tutorial-version/index.html new file mode 100644 index 0000000000..a7a64b5289 --- /dev/null +++ b/docs/ro/1.10.x/tutorial-version/index.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.10.x

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/1.10.x/versioning.html b/docs/ro/1.10.x/versioning.html new file mode 100644 index 0000000000..980d6587a5 --- /dev/null +++ b/docs/ro/1.10.x/versioning.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/1.10.x/versioning/index.html b/docs/ro/1.10.x/versioning/index.html new file mode 100644 index 0000000000..980d6587a5 --- /dev/null +++ b/docs/ro/1.10.x/versioning/index.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/1.11.x/adding-blog.html b/docs/ro/1.11.x/adding-blog.html new file mode 100644 index 0000000000..76fd3acbb3 --- /dev/null +++ b/docs/ro/1.11.x/adding-blog.html @@ -0,0 +1,202 @@ +Adding a Blog · Docusaurus

1.11.x

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

Spre exemplu, la siteweb/blog/2017-08-18-Introducând-Docusaurus.md:

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

Opțiuni Header

+

Singurul câmp necesar este titlu; cu toate acestea, vă oferim opțiuni să adăugați informații despre autor la post-area ta de blog deasemenea.

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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 added 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/ro/1.11.x/adding-blog/index.html b/docs/ro/1.11.x/adding-blog/index.html new file mode 100644 index 0000000000..76fd3acbb3 --- /dev/null +++ b/docs/ro/1.11.x/adding-blog/index.html @@ -0,0 +1,202 @@ +Adding a Blog · Docusaurus

1.11.x

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

Spre exemplu, la siteweb/blog/2017-08-18-Introducând-Docusaurus.md:

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

Opțiuni Header

+

Singurul câmp necesar este titlu; cu toate acestea, vă oferim opțiuni să adăugați informații despre autor la post-area ta de blog deasemenea.

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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 added 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/ro/1.11.x/api-pages.html b/docs/ro/1.11.x/api-pages.html new file mode 100644 index 0000000000..a567ed1dbd --- /dev/null +++ b/docs/ro/1.11.x/api-pages.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.11.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/1.11.x/api-pages/index.html b/docs/ro/1.11.x/api-pages/index.html new file mode 100644 index 0000000000..a567ed1dbd --- /dev/null +++ b/docs/ro/1.11.x/api-pages/index.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.11.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/1.11.x/commands.html b/docs/ro/1.11.x/commands.html new file mode 100644 index 0000000000..13ffb360ac --- /dev/null +++ b/docs/ro/1.11.x/commands.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

1.11.x

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/1.11.x/commands/index.html b/docs/ro/1.11.x/commands/index.html new file mode 100644 index 0000000000..13ffb360ac --- /dev/null +++ b/docs/ro/1.11.x/commands/index.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

1.11.x

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/1.11.x/custom-pages.html b/docs/ro/1.11.x/custom-pages.html new file mode 100644 index 0000000000..1d69433084 --- /dev/null +++ b/docs/ro/1.11.x/custom-pages.html @@ -0,0 +1,155 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/1.11.x/custom-pages/index.html b/docs/ro/1.11.x/custom-pages/index.html new file mode 100644 index 0000000000..1d69433084 --- /dev/null +++ b/docs/ro/1.11.x/custom-pages/index.html @@ -0,0 +1,155 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/1.11.x/doc-markdown.html b/docs/ro/1.11.x/doc-markdown.html new file mode 100644 index 0000000000..8ef9ab4116 --- /dev/null +++ b/docs/ro/1.11.x/doc-markdown.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.11.x

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/1.11.x/doc-markdown/index.html b/docs/ro/1.11.x/doc-markdown/index.html new file mode 100644 index 0000000000..8ef9ab4116 --- /dev/null +++ b/docs/ro/1.11.x/doc-markdown/index.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.11.x

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/1.11.x/docker.html b/docs/ro/1.11.x/docker.html new file mode 100644 index 0000000000..2652fd97bf --- /dev/null +++ b/docs/ro/1.11.x/docker.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.11.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/1.11.x/docker/index.html b/docs/ro/1.11.x/docker/index.html new file mode 100644 index 0000000000..2652fd97bf --- /dev/null +++ b/docs/ro/1.11.x/docker/index.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.11.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/1.11.x/installation.html b/docs/ro/1.11.x/installation.html new file mode 100644 index 0000000000..8134378683 --- /dev/null +++ b/docs/ro/1.11.x/installation.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/1.11.x/installation/index.html b/docs/ro/1.11.x/installation/index.html new file mode 100644 index 0000000000..8134378683 --- /dev/null +++ b/docs/ro/1.11.x/installation/index.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/1.11.x/navigation.html b/docs/ro/1.11.x/navigation.html new file mode 100644 index 0000000000..1b2a01f9ba --- /dev/null +++ b/docs/ro/1.11.x/navigation.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/1.11.x/navigation/index.html b/docs/ro/1.11.x/navigation/index.html new file mode 100644 index 0000000000..1b2a01f9ba --- /dev/null +++ b/docs/ro/1.11.x/navigation/index.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/1.11.x/publishing.html b/docs/ro/1.11.x/publishing.html new file mode 100644 index 0000000000..f22f976166 --- /dev/null +++ b/docs/ro/1.11.x/publishing.html @@ -0,0 +1,345 @@ +Publishing your site · Docusaurus

1.11.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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/ro/1.11.x/publishing/index.html b/docs/ro/1.11.x/publishing/index.html new file mode 100644 index 0000000000..f22f976166 --- /dev/null +++ b/docs/ro/1.11.x/publishing/index.html @@ -0,0 +1,345 @@ +Publishing your site · Docusaurus

1.11.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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/ro/1.11.x/search.html b/docs/ro/1.11.x/search.html new file mode 100644 index 0000000000..cd221395d5 --- /dev/null +++ b/docs/ro/1.11.x/search.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.11.x

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/1.11.x/search/index.html b/docs/ro/1.11.x/search/index.html new file mode 100644 index 0000000000..cd221395d5 --- /dev/null +++ b/docs/ro/1.11.x/search/index.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.11.x

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/1.11.x/site-config.html b/docs/ro/1.11.x/site-config.html new file mode 100644 index 0000000000..7d15979394 --- /dev/null +++ b/docs/ro/1.11.x/site-config.html @@ -0,0 +1,404 @@ +siteConfig.js · Docusaurus

1.11.x

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+
+

To manage syntax extensions, use the markdownPlugins field.

+
+

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.

+

For example, if you want to enable superscript and subscript in your markdown that is rendered by Remarkable to HTML, you would do the following:

+
  markdownPlugins: [
+    function foo(md) {
+      md.inline.ruler.enable(['sub', 'sup']);
+    },
+  ],
+
+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/1.11.x/site-config/index.html b/docs/ro/1.11.x/site-config/index.html new file mode 100644 index 0000000000..7d15979394 --- /dev/null +++ b/docs/ro/1.11.x/site-config/index.html @@ -0,0 +1,404 @@ +siteConfig.js · Docusaurus

1.11.x

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+
+

To manage syntax extensions, use the markdownPlugins field.

+
+

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.

+

For example, if you want to enable superscript and subscript in your markdown that is rendered by Remarkable to HTML, you would do the following:

+
  markdownPlugins: [
+    function foo(md) {
+      md.inline.ruler.enable(['sub', 'sup']);
+    },
+  ],
+
+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/1.11.x/site-creation.html b/docs/ro/1.11.x/site-creation.html new file mode 100644 index 0000000000..03a2b8e16e --- /dev/null +++ b/docs/ro/1.11.x/site-creation.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/1.11.x/site-creation/index.html b/docs/ro/1.11.x/site-creation/index.html new file mode 100644 index 0000000000..03a2b8e16e --- /dev/null +++ b/docs/ro/1.11.x/site-creation/index.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/1.11.x/site-preparation.html b/docs/ro/1.11.x/site-preparation.html new file mode 100644 index 0000000000..d9e0db7cf6 --- /dev/null +++ b/docs/ro/1.11.x/site-preparation.html @@ -0,0 +1,151 @@ +Site Preparation · Docusaurus

1.11.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

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

1.11.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

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

1.11.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

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

1.11.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-create-new-site.html b/docs/ro/1.11.x/tutorial-create-new-site.html new file mode 100644 index 0000000000..43c6e24147 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-create-new-site.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.11.x

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-create-new-site/index.html b/docs/ro/1.11.x/tutorial-create-new-site/index.html new file mode 100644 index 0000000000..43c6e24147 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-create-new-site/index.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.11.x

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-create-pages.html b/docs/ro/1.11.x/tutorial-create-pages.html new file mode 100644 index 0000000000..3799038607 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-create-pages.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.11.x

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-create-pages/index.html b/docs/ro/1.11.x/tutorial-create-pages/index.html new file mode 100644 index 0000000000..3799038607 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-create-pages/index.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.11.x

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-publish-site.html b/docs/ro/1.11.x/tutorial-publish-site.html new file mode 100644 index 0000000000..faa713dd99 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-publish-site.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.11.x

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-publish-site/index.html b/docs/ro/1.11.x/tutorial-publish-site/index.html new file mode 100644 index 0000000000..faa713dd99 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-publish-site/index.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.11.x

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-setup.html b/docs/ro/1.11.x/tutorial-setup.html new file mode 100644 index 0000000000..29302c5f80 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-setup.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.11.x

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-setup/index.html b/docs/ro/1.11.x/tutorial-setup/index.html new file mode 100644 index 0000000000..29302c5f80 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-setup/index.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.11.x

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-version.html b/docs/ro/1.11.x/tutorial-version.html new file mode 100644 index 0000000000..f815ac8685 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-version.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.11.x

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/1.11.x/tutorial-version/index.html b/docs/ro/1.11.x/tutorial-version/index.html new file mode 100644 index 0000000000..f815ac8685 --- /dev/null +++ b/docs/ro/1.11.x/tutorial-version/index.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.11.x

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/1.11.x/versioning.html b/docs/ro/1.11.x/versioning.html new file mode 100644 index 0000000000..153ebd8b16 --- /dev/null +++ b/docs/ro/1.11.x/versioning.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/1.11.x/versioning/index.html b/docs/ro/1.11.x/versioning/index.html new file mode 100644 index 0000000000..153ebd8b16 --- /dev/null +++ b/docs/ro/1.11.x/versioning/index.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/1.9.x/adding-blog.html b/docs/ro/1.9.x/adding-blog.html new file mode 100644 index 0000000000..40d0453f0d --- /dev/null +++ b/docs/ro/1.9.x/adding-blog.html @@ -0,0 +1,202 @@ +Adding a Blog · Docusaurus

1.9.x

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

Spre exemplu, la siteweb/blog/2017-08-18-Introducând-Docusaurus.md:

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

Opțiuni Header

+

Singurul câmp necesar este titlu; cu toate acestea, vă oferim opțiuni să adăugați informații despre autor la post-area ta de blog deasemenea.

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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/ro/1.9.x/adding-blog/index.html b/docs/ro/1.9.x/adding-blog/index.html new file mode 100644 index 0000000000..40d0453f0d --- /dev/null +++ b/docs/ro/1.9.x/adding-blog/index.html @@ -0,0 +1,202 @@ +Adding a Blog · Docusaurus

1.9.x

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

Spre exemplu, la siteweb/blog/2017-08-18-Introducând-Docusaurus.md:

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

Opțiuni Header

+

Singurul câmp necesar este titlu; cu toate acestea, vă oferim opțiuni să adăugați informații despre autor la post-area ta de blog deasemenea.

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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/ro/1.9.x/api-pages.html b/docs/ro/1.9.x/api-pages.html new file mode 100644 index 0000000000..d6e87cbc3e --- /dev/null +++ b/docs/ro/1.9.x/api-pages.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.9.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/1.9.x/api-pages/index.html b/docs/ro/1.9.x/api-pages/index.html new file mode 100644 index 0000000000..d6e87cbc3e --- /dev/null +++ b/docs/ro/1.9.x/api-pages/index.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.9.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/1.9.x/commands.html b/docs/ro/1.9.x/commands.html new file mode 100644 index 0000000000..74e332ebc3 --- /dev/null +++ b/docs/ro/1.9.x/commands.html @@ -0,0 +1,235 @@ +CLI Commands · Docusaurus

1.9.x

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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

+

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-scrie-traduceri

+

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/ro/1.9.x/commands/index.html b/docs/ro/1.9.x/commands/index.html new file mode 100644 index 0000000000..74e332ebc3 --- /dev/null +++ b/docs/ro/1.9.x/commands/index.html @@ -0,0 +1,235 @@ +CLI Commands · Docusaurus

1.9.x

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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

+

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-scrie-traduceri

+

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/ro/1.9.x/custom-pages.html b/docs/ro/1.9.x/custom-pages.html new file mode 100644 index 0000000000..b9fa74359e --- /dev/null +++ b/docs/ro/1.9.x/custom-pages.html @@ -0,0 +1,154 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/1.9.x/custom-pages/index.html b/docs/ro/1.9.x/custom-pages/index.html new file mode 100644 index 0000000000..b9fa74359e --- /dev/null +++ b/docs/ro/1.9.x/custom-pages/index.html @@ -0,0 +1,154 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/1.9.x/doc-markdown.html b/docs/ro/1.9.x/doc-markdown.html new file mode 100644 index 0000000000..0441b0b1da --- /dev/null +++ b/docs/ro/1.9.x/doc-markdown.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.9.x

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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/ro/1.9.x/doc-markdown/index.html b/docs/ro/1.9.x/doc-markdown/index.html new file mode 100644 index 0000000000..0441b0b1da --- /dev/null +++ b/docs/ro/1.9.x/doc-markdown/index.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.9.x

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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/ro/1.9.x/docker.html b/docs/ro/1.9.x/docker.html new file mode 100644 index 0000000000..bfe187ff0a --- /dev/null +++ b/docs/ro/1.9.x/docker.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.9.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/1.9.x/docker/index.html b/docs/ro/1.9.x/docker/index.html new file mode 100644 index 0000000000..bfe187ff0a --- /dev/null +++ b/docs/ro/1.9.x/docker/index.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.9.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/1.9.x/installation.html b/docs/ro/1.9.x/installation.html new file mode 100644 index 0000000000..d782259024 --- /dev/null +++ b/docs/ro/1.9.x/installation.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/1.9.x/installation/index.html b/docs/ro/1.9.x/installation/index.html new file mode 100644 index 0000000000..d782259024 --- /dev/null +++ b/docs/ro/1.9.x/installation/index.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/1.9.x/navigation.html b/docs/ro/1.9.x/navigation.html new file mode 100644 index 0000000000..4e217021b8 --- /dev/null +++ b/docs/ro/1.9.x/navigation.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

Dacă traducerile sunt activate pe site-ul tău, dropdown-ul de limbi va apărea la dreapta link-urilor tale (și la stânga bării de căutare, dacă căutarea este activă). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/1.9.x/navigation/index.html b/docs/ro/1.9.x/navigation/index.html new file mode 100644 index 0000000000..4e217021b8 --- /dev/null +++ b/docs/ro/1.9.x/navigation/index.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

Dacă traducerile sunt activate pe site-ul tău, dropdown-ul de limbi va apărea la dreapta link-urilor tale (și la stânga bării de căutare, dacă căutarea este activă). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/1.9.x/publishing.html b/docs/ro/1.9.x/publishing.html new file mode 100644 index 0000000000..91ad7ecee7 --- /dev/null +++ b/docs/ro/1.9.x/publishing.html @@ -0,0 +1,345 @@ +Publishing your site · Docusaurus

1.9.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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/ro/1.9.x/publishing/index.html b/docs/ro/1.9.x/publishing/index.html new file mode 100644 index 0000000000..91ad7ecee7 --- /dev/null +++ b/docs/ro/1.9.x/publishing/index.html @@ -0,0 +1,345 @@ +Publishing your site · Docusaurus

1.9.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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/ro/1.9.x/search.html b/docs/ro/1.9.x/search.html new file mode 100644 index 0000000000..15cea5e6f7 --- /dev/null +++ b/docs/ro/1.9.x/search.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.9.x

Translate

Enabling Search

Docusaurus suportă căutarea utilizând 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.

+

Activând bara de Căutare

+

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/ro/1.9.x/search/index.html b/docs/ro/1.9.x/search/index.html new file mode 100644 index 0000000000..15cea5e6f7 --- /dev/null +++ b/docs/ro/1.9.x/search/index.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.9.x

Translate

Enabling Search

Docusaurus suportă căutarea utilizând 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.

+

Activând bara de Căutare

+

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/ro/1.9.x/site-config.html b/docs/ro/1.9.x/site-config.html new file mode 100644 index 0000000000..c3c8bbd16d --- /dev/null +++ b/docs/ro/1.9.x/site-config.html @@ -0,0 +1,392 @@ +siteConfig.js · Docusaurus

1.9.x

Translate

siteConfig.js

O mare parte a configurării site-ului este efectuată prin editarea fișierului siteConfig.js.

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. În mod curent acest câmp este utilizat de exemplu fișierele pagini/en/index.js și pagini/en/users.js date. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

În mod curent, array-ul utilizatori este folosit doar de fișierele exemplu index.js și users.js. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

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.

+

Exemplu de utilizare:

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

+

Câmpuri Opţionale

+

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 [array]

+

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/ro/1.9.x/site-config/index.html b/docs/ro/1.9.x/site-config/index.html new file mode 100644 index 0000000000..c3c8bbd16d --- /dev/null +++ b/docs/ro/1.9.x/site-config/index.html @@ -0,0 +1,392 @@ +siteConfig.js · Docusaurus

1.9.x

Translate

siteConfig.js

O mare parte a configurării site-ului este efectuată prin editarea fișierului siteConfig.js.

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. În mod curent acest câmp este utilizat de exemplu fișierele pagini/en/index.js și pagini/en/users.js date. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

În mod curent, array-ul utilizatori este folosit doar de fișierele exemplu index.js și users.js. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

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.

+

Exemplu de utilizare:

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

+

Câmpuri Opţionale

+

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 [array]

+

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/ro/1.9.x/site-creation.html b/docs/ro/1.9.x/site-creation.html new file mode 100644 index 0000000000..c5e8ac047b --- /dev/null +++ b/docs/ro/1.9.x/site-creation.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/1.9.x/site-creation/index.html b/docs/ro/1.9.x/site-creation/index.html new file mode 100644 index 0000000000..c5e8ac047b --- /dev/null +++ b/docs/ro/1.9.x/site-creation/index.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/1.9.x/site-preparation.html b/docs/ro/1.9.x/site-preparation.html new file mode 100644 index 0000000000..58c9ee5a9c --- /dev/null +++ b/docs/ro/1.9.x/site-preparation.html @@ -0,0 +1,151 @@ +Site Preparation · Docusaurus

1.9.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

Va fi necesar să păstrați fișierele siteweb/siteConfig.js și siteweb/core/Footer.js, dar le puteți edita după cum doriți. 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. Ca și cerință minimă ar trebuii să aveți un fișier en/index.js sau en/index.html înăuntrul la siteweb/pagini și o imagine pe care să o utilizezi ca iconiță a header-ului înăuntrul la siteweb/static.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/ro/1.9.x/site-preparation/index.html b/docs/ro/1.9.x/site-preparation/index.html new file mode 100644 index 0000000000..58c9ee5a9c --- /dev/null +++ b/docs/ro/1.9.x/site-preparation/index.html @@ -0,0 +1,151 @@ +Site Preparation · Docusaurus

1.9.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

Va fi necesar să păstrați fișierele siteweb/siteConfig.js și siteweb/core/Footer.js, dar le puteți edita după cum doriți. 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. Ca și cerință minimă ar trebuii să aveți un fișier en/index.js sau en/index.html înăuntrul la siteweb/pagini și o imagine pe care să o utilizezi ca iconiță a header-ului înăuntrul la siteweb/static.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

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

1.9.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • Fișierul pagini/en/ajutor-cu-traduceri.js include aceeași pagină starter de ajutor generată de script-ul exemple, dar care acum include tag-urile de traducere.
    • +
+
+

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pagini îți permite să personalizezi layout-ul și conținutul specific al paginilor ca o pagină personalizată de index sau o pagină de ajutor.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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.

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. Cu toate acestea, menținerea unei liste de șiruri utilizate într-un site poate fi laborioasă. Docusaurus simplifies this by centralizing strings.

+

Header-ul de navigație, spre exemplu, poate avea link-uri către 'Acasă' sau 'Blog'-ul tău. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

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

1.9.x

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

+
pages/en/help-with-translations.js
+languages.js
+../crowdin.yaml
+
+
    +
  • Fișierul pagini/en/ajutor-cu-traduceri.js include aceeași pagină starter de ajutor generată de script-ul exemple, dar care acum include tag-urile de traducere.
    • +
+
+

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pagini îți permite să personalizezi layout-ul și conținutul specific al paginilor ca o pagină personalizată de index sau o pagină de ajutor.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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.

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. Cu toate acestea, menținerea unei liste de șiruri utilizate într-un site poate fi laborioasă. Docusaurus simplifies this by centralizing strings.

+

Header-ul de navigație, spre exemplu, poate avea link-uri către 'Acasă' sau 'Blog'-ul tău. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, a i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-create-new-site.html b/docs/ro/1.9.x/tutorial-create-new-site.html new file mode 100644 index 0000000000..7592a6db20 --- /dev/null +++ b/docs/ro/1.9.x/tutorial-create-new-site.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.9.x

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-create-new-site/index.html b/docs/ro/1.9.x/tutorial-create-new-site/index.html new file mode 100644 index 0000000000..7592a6db20 --- /dev/null +++ b/docs/ro/1.9.x/tutorial-create-new-site/index.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.9.x

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-create-pages.html b/docs/ro/1.9.x/tutorial-create-pages.html new file mode 100644 index 0000000000..ee25778602 --- /dev/null +++ b/docs/ro/1.9.x/tutorial-create-pages.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.9.x

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-create-pages/index.html b/docs/ro/1.9.x/tutorial-create-pages/index.html new file mode 100644 index 0000000000..ee25778602 --- /dev/null +++ b/docs/ro/1.9.x/tutorial-create-pages/index.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.9.x

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-publish-site.html b/docs/ro/1.9.x/tutorial-publish-site.html new file mode 100644 index 0000000000..3cc105bbd3 --- /dev/null +++ b/docs/ro/1.9.x/tutorial-publish-site.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.9.x

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-publish-site/index.html b/docs/ro/1.9.x/tutorial-publish-site/index.html new file mode 100644 index 0000000000..3cc105bbd3 --- /dev/null +++ b/docs/ro/1.9.x/tutorial-publish-site/index.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.9.x

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-setup.html b/docs/ro/1.9.x/tutorial-setup.html new file mode 100644 index 0000000000..6f00092c8d --- /dev/null +++ b/docs/ro/1.9.x/tutorial-setup.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.9.x

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-setup/index.html b/docs/ro/1.9.x/tutorial-setup/index.html new file mode 100644 index 0000000000..6f00092c8d --- /dev/null +++ b/docs/ro/1.9.x/tutorial-setup/index.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.9.x

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-version.html b/docs/ro/1.9.x/tutorial-version.html new file mode 100644 index 0000000000..dc9080408b --- /dev/null +++ b/docs/ro/1.9.x/tutorial-version.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.9.x

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/1.9.x/tutorial-version/index.html b/docs/ro/1.9.x/tutorial-version/index.html new file mode 100644 index 0000000000..dc9080408b --- /dev/null +++ b/docs/ro/1.9.x/tutorial-version/index.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.9.x

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/1.9.x/versioning.html b/docs/ro/1.9.x/versioning.html new file mode 100644 index 0000000000..59f1743c75 --- /dev/null +++ b/docs/ro/1.9.x/versioning.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/1.9.x/versioning/index.html b/docs/ro/1.9.x/versioning/index.html new file mode 100644 index 0000000000..59f1743c75 --- /dev/null +++ b/docs/ro/1.9.x/versioning/index.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/adding-blog.html b/docs/ro/adding-blog.html new file mode 100644 index 0000000000..137e55cacf --- /dev/null +++ b/docs/ro/adding-blog.html @@ -0,0 +1,203 @@ +Adding a Blog · Docusaurus

1.12.0

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

For example, at website/blog/2017-12-14-introducing-docusaurus.md:

+
---
+title: Introducing Docusaurus
+author: Joel Marcey
+authorURL: http://twitter.com/JoelMarcey
+authorFBID: 611217057
+authorTwitter: JoelMarcey
+---
+Lorem Ipsum...
+
+

Opțiuni Header

+

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

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
  • unlisted - The post will be accessible by directly visiting the URL but will not show up in the sidebar in the final build; during local development, the post will still be listed. Useful in situations where you want to share a WIP post with others for feedback.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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 added 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 to 250 characters is 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/ro/adding-blog/index.html b/docs/ro/adding-blog/index.html new file mode 100644 index 0000000000..137e55cacf --- /dev/null +++ b/docs/ro/adding-blog/index.html @@ -0,0 +1,203 @@ +Adding a Blog · Docusaurus

1.12.0

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

For example, at website/blog/2017-12-14-introducing-docusaurus.md:

+
---
+title: Introducing Docusaurus
+author: Joel Marcey
+authorURL: http://twitter.com/JoelMarcey
+authorFBID: 611217057
+authorTwitter: JoelMarcey
+---
+Lorem Ipsum...
+
+

Opțiuni Header

+

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

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
  • unlisted - The post will be accessible by directly visiting the URL but will not show up in the sidebar in the final build; during local development, the post will still be listed. Useful in situations where you want to share a WIP post with others for feedback.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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 added 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 to 250 characters is 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/ro/api-pages.html b/docs/ro/api-pages.html new file mode 100644 index 0000000000..986b9a5258 --- /dev/null +++ b/docs/ro/api-pages.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.12.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/api-pages/index.html b/docs/ro/api-pages/index.html new file mode 100644 index 0000000000..986b9a5258 --- /dev/null +++ b/docs/ro/api-pages/index.html @@ -0,0 +1,274 @@ +Pages and Styles · Docusaurus

1.12.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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/commands.html b/docs/ro/commands.html new file mode 100644 index 0000000000..59c2f6e293 --- /dev/null +++ b/docs/ro/commands.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

1.12.0

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/commands/index.html b/docs/ro/commands/index.html new file mode 100644 index 0000000000..59c2f6e293 --- /dev/null +++ b/docs/ro/commands/index.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

1.12.0

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/custom-pages.html b/docs/ro/custom-pages.html new file mode 100644 index 0000000000..69184e36f4 --- /dev/null +++ b/docs/ro/custom-pages.html @@ -0,0 +1,155 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/custom-pages/index.html b/docs/ro/custom-pages/index.html new file mode 100644 index 0000000000..69184e36f4 --- /dev/null +++ b/docs/ro/custom-pages/index.html @@ -0,0 +1,155 @@ +Custom Pages · Docusaurus

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

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/doc-markdown.html b/docs/ro/doc-markdown.html new file mode 100644 index 0000000000..8c5b515aa0 --- /dev/null +++ b/docs/ro/doc-markdown.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.12.0

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/doc-markdown/index.html b/docs/ro/doc-markdown/index.html new file mode 100644 index 0000000000..8c5b515aa0 --- /dev/null +++ b/docs/ro/doc-markdown/index.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

1.12.0

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/docker.html b/docs/ro/docker.html new file mode 100644 index 0000000000..656b3945c3 --- /dev/null +++ b/docs/ro/docker.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.12.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/docker/index.html b/docs/ro/docker/index.html new file mode 100644 index 0000000000..656b3945c3 --- /dev/null +++ b/docs/ro/docker/index.html @@ -0,0 +1,155 @@ +Docker · Docusaurus

1.12.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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/installation.html b/docs/ro/installation.html new file mode 100644 index 0000000000..c533b6173b --- /dev/null +++ b/docs/ro/installation.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/installation/index.html b/docs/ro/installation/index.html new file mode 100644 index 0000000000..c533b6173b --- /dev/null +++ b/docs/ro/installation/index.html @@ -0,0 +1,194 @@ +Installation · Docusaurus

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

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/navigation.html b/docs/ro/navigation.html new file mode 100644 index 0000000000..7ae3d0a559 --- /dev/null +++ b/docs/ro/navigation.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/navigation/index.html b/docs/ro/navigation/index.html new file mode 100644 index 0000000000..7ae3d0a559 --- /dev/null +++ b/docs/ro/navigation/index.html @@ -0,0 +1,318 @@ +Navigation and Sidebars · Docusaurus

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

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/next/adding-blog.html b/docs/ro/next/adding-blog.html new file mode 100644 index 0000000000..8caad360b5 --- /dev/null +++ b/docs/ro/next/adding-blog.html @@ -0,0 +1,203 @@ +Adding a Blog · Docusaurus

next

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

For example, at website/blog/2017-12-14-introducing-docusaurus.md:

+
---
+title: Introducing Docusaurus
+author: Joel Marcey
+authorURL: http://twitter.com/JoelMarcey
+authorFBID: 611217057
+authorTwitter: JoelMarcey
+---
+Lorem Ipsum...
+
+

Opțiuni Header

+

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

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
  • unlisted - The post will be accessible by directly visiting the URL but will not show up in the sidebar in the final build; during local development, the post will still be listed. Useful in situations where you want to share a WIP post with others for feedback.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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 added 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 to 250 characters is 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/ro/next/adding-blog/index.html b/docs/ro/next/adding-blog/index.html new file mode 100644 index 0000000000..8caad360b5 --- /dev/null +++ b/docs/ro/next/adding-blog/index.html @@ -0,0 +1,203 @@ +Adding a Blog · Docusaurus

next

Translate

Adding a Blog

Setup inițial

+

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

+

Apoi, adaugă un link header la blog-ul tău în interiorul siteConfig.js:

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

Adăugarea de Post-uri

+

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.

+

For example, at website/blog/2017-12-14-introducing-docusaurus.md:

+
---
+title: Introducing Docusaurus
+author: Joel Marcey
+authorURL: http://twitter.com/JoelMarcey
+authorFBID: 611217057
+authorTwitter: JoelMarcey
+---
+Lorem Ipsum...
+
+

Opțiuni Header

+

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

+
    +
  • autor - Eticheta textului a byline-ului autorului.
    • +
  • 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.
    • +
  • unlisted - The post will be accessible by directly visiting the URL but will not show up in the sidebar in the final build; during local development, the post will still be listed. Useful in situations where you want to share a WIP post with others for feedback.
    • +
+

Sumarul pe scurt

+

Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Orice mai sus <!--truncate--> vor fi parte din sumar. De exemplu:

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

+

Exemplu:

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

+

Exemplu:

+
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 added 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 to 250 characters is 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/ro/next/api-pages.html b/docs/ro/next/api-pages.html new file mode 100644 index 0000000000..a84d88b925 --- /dev/null +++ b/docs/ro/next/api-pages.html @@ -0,0 +1,274 @@ +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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/next/api-pages/index.html b/docs/ro/next/api-pages/index.html new file mode 100644 index 0000000000..a84d88b925 --- /dev/null +++ b/docs/ro/next/api-pages/index.html @@ -0,0 +1,274 @@ +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. Fișierele din siteweb/pagini/en deasemenea va fi copiată în pagini și va SUPRASCRIE orice fișiere cu același nume din pagini. 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 fieldset 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.

+

Exemplu:

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

+

Exemplu:

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

+

Exemplu:

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

LibrărieComp.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>
+
+

LibrărieComp.BlocGrilă

+

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/ro/next/commands.html b/docs/ro/next/commands.html new file mode 100644 index 0000000000..9e04ee04fa --- /dev/null +++ b/docs/ro/next/commands.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

next

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/next/commands/index.html b/docs/ro/next/commands/index.html new file mode 100644 index 0000000000..9e04ee04fa --- /dev/null +++ b/docs/ro/next/commands/index.html @@ -0,0 +1,236 @@ +CLI Commands · Docusaurus

next

Translate

CLI Commands

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

+ +

Rulează din linia de comandă

+

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

+
yarn run start
+
+

Același script poate fi utilizat folosind npm:

+
npm run start
+
+

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

+

Folosind argumente

+

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

+
yarn run start --port 8080
+
+

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

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

Configurație

+

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

+

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

+

Comenzi

+ +
+

Referințe

+

docusaurus-build

+

Alias: 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

+

Alias: exemple

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

+

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_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
    • +
  • 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: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
    • +
  • CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.
    • +
+

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.
--host <host>localhostSpecify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.
--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-versiune <versiune>

+

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-scrie-traduceri

+

Alias: write-translations

+

Writes the English for any strings that need to be translated into a 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/ro/next/custom-pages.html b/docs/ro/next/custom-pages.html new file mode 100644 index 0000000000..1e25f15c61 --- /dev/null +++ b/docs/ro/next/custom-pages.html @@ -0,0 +1,155 @@ +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.

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/next/custom-pages/index.html b/docs/ro/next/custom-pages/index.html new file mode 100644 index 0000000000..1e25f15c61 --- /dev/null +++ b/docs/ro/next/custom-pages/index.html @@ -0,0 +1,155 @@ +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.

+

Personalizând pagina de Acasă

+

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. De aici, editează fișierul siteweb/pagini/en/index.js și componentele sale variate pentru a utiliza imaginile și textul pe care le dorești pentru proiectul tău.

+

Adăugarea altor Pagini Personalizate

+

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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.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. Mai multă informație despre cum să utilizezi componentele furnizate sau să le incluzi pe ale tale poate fi găsită aici. Informație despre cum să link-uiești diferite pagini în bara de navigație pot fi găsite aici.

+
+

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/' },

+
+

Adaugând pagini statice

+

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.

+
+

Personalizând footerul site-ului tău

+

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.

+

Exemplul furnizat are trei coloane cu o imagine footer pe partea stângă și logo-ul open source Facebook și copyright-ul în josul paginii. Dacă proiectul tău nu este un proiect open source Facebook, elimină logo-ul și copyright-ul. Altfel, simte-te liber să devii creativ cu footer-ul tău și să îl faci să arate exact așa cum dorești!

+

Niște sugestii de link-uri pe care ai vrea să le furnizezi: documentație, API, Twitter, Discord, Facebook, Stack Overflow, GitHub, etc.

+

Your footer will automatically get applied to all pages on your site, including docs and blog posts. The sole exception to this is any static HTML pages you include.

+

If you do not want a footer for your site, change the render function of core/Footer.js to return null. e.g.,

+
const React = require('react');
+
+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/ro/next/doc-markdown.html b/docs/ro/next/doc-markdown.html new file mode 100644 index 0000000000..21adb459bc --- /dev/null +++ b/docs/ro/next/doc-markdown.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

next

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/next/doc-markdown/index.html b/docs/ro/next/doc-markdown/index.html new file mode 100644 index 0000000000..21adb459bc --- /dev/null +++ b/docs/ro/next/doc-markdown/index.html @@ -0,0 +1,250 @@ +Markdown Features · Docusaurus

next

Translate

Markdown Features

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

+

Head-ere Markdown

+

Documente

+

Documentele utilizează următoarele câmpuri markdown header ce sunt anexate printr-o linie --- pe orice parte:

+

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.

+

De exemplu:

+
---
+id: doc1
+titlu: Documentul meu
+sidebar_label: Document
+---
+
+

Documentele cu versiuni au id-urile alterate pentru a include numărul versiunii când este copiat. Noul id este versiune-${version}-${id} unde ${version} este numărul versiunii acelui document și ${id} este id-ul original. Adițional, documentele cu versiuni au un câmp original_id adăugat cu id-ul original al documentului.

+

De exemplu:

+
---
+id: versiune-1.0.0-doc1
+titlu: Documentul meu
+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.

+

De exemplu:

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

Post-uri pentru Blog

+

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

+

titlu: Titlul acestui post pentru blog.

+

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.

+

autorFBID: Id-ul de Facebook al autorului, folosit doar pentru a lua poza de profil a autorului pentru a fi afișată odată cu post-area de pe blog. Dacă acest câmp este omis, autorul nu va avea nici o imagine afișată pentru post-area de pe blog.

+

De exemplu:

+
---
+titlu: Prima mea post-are pe blog
+autor: Frank Li
+URLautor: http://twitter.com/franchementli
+autorFBID: 100002976521003
+---
+
+

Caracteristici suplimentare

+

Docusaurus suportă niște caracteristici suplimentare când documentația este scrisă în markdown.

+

Link-uirea cu alte Documente

+

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

+

Exemplu:

+
[Acesta link-uiește către alt document](celălalt-document.md)
+
+

Acest markdown va fi convertit automat într-un link pentru /documente/celălalt-document.html (sau la link-ul cu traducerea/versiunea corespunzătoare) odată ce va fi redată.

+

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.

+

Link-uirea către Imagini sau Alte Asset-uri

+

Static assets can be linked to in the same way that documents are, using relative URLs. Asset-urile statice utilizate în documente și bloguri ar trebuii să se ducă în documente/asset-uri și siteweb/blog/asset-uri, respectiv. Markdown-ul va fi convertit în căile correcte ale link-urilor astfel încât aceste căi vor funcționa pentru documente în toate limbile și versiunile.

+

Exemplu:

+
![alt-text](asset-uri/imaginea-documentului.png)
+
+

Generând Cuprinsul

+

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 ``. Scrie-ți documentația folosind header-e h3 pentru fiecare funcție în interiorul unui bloc de cod. These will be found by Docusaurus and a list of links to these sections will be inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.

+

Exemplu:

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

va duce la un cuprins al funcțiilor:

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

și fiecare funcție va link-ui către secțiunile corespunzătoare din pagină.

+

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

+

Exemplu:

+
// 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 the 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/ro/next/docker.html b/docs/ro/next/docker.html new file mode 100644 index 0000000000..04845ff01e --- /dev/null +++ b/docs/ro/next/docker.html @@ -0,0 +1,155 @@ +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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/next/docker/index.html b/docs/ro/next/docker/index.html new file mode 100644 index 0000000000..04845ff01e --- /dev/null +++ b/docs/ro/next/docker/index.html @@ -0,0 +1,155 @@ +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 web server in docker

+

Ensure you have previously installed docker.

+

To run the local web server:

+
    +

  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 web server 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 web server 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/ro/next/installation.html b/docs/ro/next/installation.html new file mode 100644 index 0000000000..50a181dee9 --- /dev/null +++ b/docs/ro/next/installation.html @@ -0,0 +1,194 @@ +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 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. +
+

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/next/installation/index.html b/docs/ro/next/installation/index.html new file mode 100644 index 0000000000..50a181dee9 --- /dev/null +++ b/docs/ro/next/installation/index.html @@ -0,0 +1,194 @@ +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 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. +
+

Verificând instalarea

+

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

+
root-directory
+├── Dockerfile
+├── README.md
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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. siteweb cd

    2. +

  2. From within the website directory, run the local web server using yarn start or npm start.

    3. +

  3. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

    +

    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. A randomly generated primary and secondary theme color will be picked for you.

    4. +
+

+

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

sau

+
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/ro/next/navigation.html b/docs/ro/next/navigation.html new file mode 100644 index 0000000000..b4cc58a012 --- /dev/null +++ b/docs/ro/next/navigation.html @@ -0,0 +1,318 @@ +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"
+    ],
+    ...
+  },
+  ...
+}
+
+

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/next/navigation/index.html b/docs/ro/next/navigation/index.html new file mode 100644 index 0000000000..b4cc58a012 --- /dev/null +++ b/docs/ro/next/navigation/index.html @@ -0,0 +1,318 @@ +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"
+    ],
+    ...
+  },
+  ...
+}
+
+

Sau poți crea o nouă categorie în interiorul sidebar-ului:

+
{
+  "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. De exemplu, dacă avem o pagină în interiorul siteweb/pagini/ajutor.js, putem să creăm un link către ea prin adăugare următoarelor:

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

+
+

Pentru a deschide link-uri externe într-un nou tab, furnizează un flag external: true în interiorul link-ului de configurare header.

+
+

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

+

Dacă căutarea este activată pe site-ul tău, bara ta de căutare va apărea la dreapta link-urilor tale. Dacă vrei să pui bara de căutare între link-urile din header, adaugă o intrare de căutare în array-ul de configurare linkuriHeader:

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

Languages Dropdown

+

If translations are enabled on your site, the language dropdown will appear to the right of your links (and to the left of the search bar, if search is enabled). Dacă vrei să pui drop down-ul de selecție a limbii între link-urile din header, adaugă o intrare de limbi în array-ul de configurare linkuriHeader:

+
{
+  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/ro/next/publishing.html b/docs/ro/next/publishing.html new file mode 100644 index 0000000000..5ac1b4a494 --- /dev/null +++ b/docs/ro/next/publishing.html @@ -0,0 +1,368 @@ +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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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

+
+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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.

+

Hosting on Render

+

Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploys from your Git repo. Deploy your app in just a few minutes by following these steps.

+
    +

  1. Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.

    2. +

  2. Select the branch to deploy. The default is master.

    3. +

  3. Enter the following values during creation.

    + + + + + + + + + +
    FieldValue
    EnvironmentStatic Site
    Build Commandcd website; yarn install; yarn build
    Publish Directorywebsite/build/<projectName>
    +

    projectName is the value you defined in your siteConfig.js.

    +
    const siteConfig = {
+  // ...
+  projectName: 'your-project-name',
+  // ...
+
    4. +
+

That's it! Your app will be live on your Render URL as soon as the build finishes.

+

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/ro/next/publishing/index.html b/docs/ro/next/publishing/index.html new file mode 100644 index 0000000000..5ac1b4a494 --- /dev/null +++ b/docs/ro/next/publishing/index.html @@ -0,0 +1,368 @@ +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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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

+
+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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.

+

Hosting on Render

+

Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploys from your Git repo. Deploy your app in just a few minutes by following these steps.

+
    +

  1. Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.

    2. +

  2. Select the branch to deploy. The default is master.

    3. +

  3. Enter the following values during creation.

    + + + + + + + + + +
    FieldValue
    EnvironmentStatic Site
    Build Commandcd website; yarn install; yarn build
    Publish Directorywebsite/build/<projectName>
    +

    projectName is the value you defined in your siteConfig.js.

    +
    const siteConfig = {
+  // ...
+  projectName: 'your-project-name',
+  // ...
+
    4. +
+

That's it! Your app will be live on your Render URL as soon as the build finishes.

+

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/ro/next/search.html b/docs/ro/next/search.html new file mode 100644 index 0000000000..fe4065b0e0 --- /dev/null +++ b/docs/ro/next/search.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

next

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/next/search/index.html b/docs/ro/next/search/index.html new file mode 100644 index 0000000000..fe4065b0e0 --- /dev/null +++ b/docs/ro/next/search/index.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

next

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/next/site-config.html b/docs/ro/next/site-config.html new file mode 100644 index 0000000000..e1835c722e --- /dev/null +++ b/docs/ro/next/site-config.html @@ -0,0 +1,404 @@ +siteConfig.js · Docusaurus

next

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+
+

To manage syntax extensions, use the markdownPlugins field.

+
+

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.

+

For example, if you want to enable superscript and subscript in your markdown that is rendered by Remarkable to HTML, you would do the following:

+
  markdownPlugins: [
+    function foo(md) {
+      md.inline.ruler.enable(['sub', 'sup']);
+    },
+  ],
+
+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/next/site-config/index.html b/docs/ro/next/site-config/index.html new file mode 100644 index 0000000000..e1835c722e --- /dev/null +++ b/docs/ro/next/site-config/index.html @@ -0,0 +1,404 @@ +siteConfig.js · Docusaurus

next

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+
+

To manage syntax extensions, use the markdownPlugins field.

+
+

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.

+

For example, if you want to enable superscript and subscript in your markdown that is rendered by Remarkable to HTML, you would do the following:

+
  markdownPlugins: [
+    function foo(md) {
+      md.inline.ruler.enable(['sub', 'sup']);
+    },
+  ],
+
+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/next/site-creation.html b/docs/ro/next/site-creation.html new file mode 100644 index 0000000000..4acd8da414 --- /dev/null +++ b/docs/ro/next/site-creation.html @@ -0,0 +1,183 @@ +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.

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/next/site-creation/index.html b/docs/ro/next/site-creation/index.html new file mode 100644 index 0000000000..4acd8da414 --- /dev/null +++ b/docs/ro/next/site-creation/index.html @@ -0,0 +1,183 @@ +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.

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/next/site-preparation.html b/docs/ro/next/site-preparation.html new file mode 100644 index 0000000000..a82ff7b6f2 --- /dev/null +++ b/docs/ro/next/site-preparation.html @@ -0,0 +1,151 @@ +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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/ro/next/site-preparation/index.html b/docs/ro/next/site-preparation/index.html new file mode 100644 index 0000000000..a82ff7b6f2 --- /dev/null +++ b/docs/ro/next/site-preparation/index.html @@ -0,0 +1,151 @@ +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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

+
← InstallationCreating your site →
\ No newline at end of file diff --git a/docs/ro/next/translation.html b/docs/ro/next/translation.html new file mode 100644 index 0000000000..6c1c75483c --- /dev/null +++ b/docs/ro/next/translation.html @@ -0,0 +1,331 @@ +Translations & Localization · Docusaurus

next

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/ro/next/translation/index.html b/docs/ro/next/translation/index.html new file mode 100644 index 0000000000..6c1c75483c --- /dev/null +++ b/docs/ro/next/translation/index.html @@ -0,0 +1,331 @@ +Translations & Localization · Docusaurus

next

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-create-new-site.html b/docs/ro/next/tutorial-create-new-site.html new file mode 100644 index 0000000000..4e82a6716f --- /dev/null +++ b/docs/ro/next/tutorial-create-new-site.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

next

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-create-new-site/index.html b/docs/ro/next/tutorial-create-new-site/index.html new file mode 100644 index 0000000000..4e82a6716f --- /dev/null +++ b/docs/ro/next/tutorial-create-new-site/index.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

next

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-create-pages.html b/docs/ro/next/tutorial-create-pages.html new file mode 100644 index 0000000000..b749afbd54 --- /dev/null +++ b/docs/ro/next/tutorial-create-pages.html @@ -0,0 +1,184 @@ +Create Pages · Docusaurus

next

Translate

Create Pages

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

+

Docusaurus MacBook

+

Create a Regular Page

+
    +

  1. In the website/pages/en directory of your repository, save a text file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
+

Use any text editor to make the file, such as Microsoft Visual Studio Code or Komodo Edit.

+
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-create-pages/index.html b/docs/ro/next/tutorial-create-pages/index.html new file mode 100644 index 0000000000..b749afbd54 --- /dev/null +++ b/docs/ro/next/tutorial-create-pages/index.html @@ -0,0 +1,184 @@ +Create Pages · Docusaurus

next

Translate

Create Pages

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

+

Docusaurus MacBook

+

Create a Regular Page

+
    +

  1. In the website/pages/en directory of your repository, save a text file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
+

Use any text editor to make the file, such as Microsoft Visual Studio Code or Komodo Edit.

+
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-publish-site.html b/docs/ro/next/tutorial-publish-site.html new file mode 100644 index 0000000000..07c1a68e02 --- /dev/null +++ b/docs/ro/next/tutorial-publish-site.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

next

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-publish-site/index.html b/docs/ro/next/tutorial-publish-site/index.html new file mode 100644 index 0000000000..07c1a68e02 --- /dev/null +++ b/docs/ro/next/tutorial-publish-site/index.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

next

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-setup.html b/docs/ro/next/tutorial-setup.html new file mode 100644 index 0000000000..9f4458d842 --- /dev/null +++ b/docs/ro/next/tutorial-setup.html @@ -0,0 +1,173 @@ +Setting Up · Docusaurus

next

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Git

+

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

+

Install Node.js

+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node.
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+

Install Yarn (Optional)

+

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub repository and local clone

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on the green New button or go to https://github.com/new.
    3. +
  3. Type a repository name without spaces. For example, docusaurus-tutorial.
    4. +
  4. Click Create repository (without .gitignore and without a license).
    5. +
+

GitHub create repo

+
    +
  1. In your terminal, cd to a directory where the local clone will be a subdirectory. (For help see Introduction to the command-line interface.)
    2. +
+
cd /Users/USERNAME/doc_projects # macOS example
+# or
+cd /c/USERNAME/doc_projects # Windows example
+
+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. cd to the directory of your local repository.
    2. +
+
cd docusaurus-tutorial
+
+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-setup/index.html b/docs/ro/next/tutorial-setup/index.html new file mode 100644 index 0000000000..9f4458d842 --- /dev/null +++ b/docs/ro/next/tutorial-setup/index.html @@ -0,0 +1,173 @@ +Setting Up · Docusaurus

next

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Git

+

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

+

Install Node.js

+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node.
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+

Install Yarn (Optional)

+

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub repository and local clone

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on the green New button or go to https://github.com/new.
    3. +
  3. Type a repository name without spaces. For example, docusaurus-tutorial.
    4. +
  4. Click Create repository (without .gitignore and without a license).
    5. +
+

GitHub create repo

+
    +
  1. In your terminal, cd to a directory where the local clone will be a subdirectory. (For help see Introduction to the command-line interface.)
    2. +
+
cd /Users/USERNAME/doc_projects # macOS example
+# or
+cd /c/USERNAME/doc_projects # Windows example
+
+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. cd to the directory of your local repository.
    2. +
+
cd docusaurus-tutorial
+
+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/next/tutorial-version.html b/docs/ro/next/tutorial-version.html new file mode 100644 index 0000000000..ec15a5fdcf --- /dev/null +++ b/docs/ro/next/tutorial-version.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

next

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/next/tutorial-version/index.html b/docs/ro/next/tutorial-version/index.html new file mode 100644 index 0000000000..ec15a5fdcf --- /dev/null +++ b/docs/ro/next/tutorial-version/index.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

next

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/next/versioning.html b/docs/ro/next/versioning.html new file mode 100644 index 0000000000..7136b7660c --- /dev/null +++ b/docs/ro/next/versioning.html @@ -0,0 +1,164 @@ +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.

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/next/versioning/index.html b/docs/ro/next/versioning/index.html new file mode 100644 index 0000000000..7136b7660c --- /dev/null +++ b/docs/ro/next/versioning/index.html @@ -0,0 +1,164 @@ +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.

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/publishing.html b/docs/ro/publishing.html new file mode 100644 index 0000000000..692b15182f --- /dev/null +++ b/docs/ro/publishing.html @@ -0,0 +1,374 @@ +Publishing your site · Docusaurus

1.12.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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

+
+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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

+

Hosting on Render

+

Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploys from your Git repo. Deploy your app in just a few minutes by following these steps.

+
    +

  1. Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.

    2. +

  2. Select the branch to deploy. The default is master.

    3. +

  3. Enter the following values during creation.

    + + + + + + + + + +
    FieldValue
    EnvironmentStatic Site
    Build Commandcd website; yarn install; yarn build
    Publish Directorywebsite/build/<projectName>
    +
    4. +
+
`projectName` is the value you defined in your `siteConfig.js`.
+
+```javascript{7}
+const siteConfig = {
+  // ...
+  projectName: 'your-project-name',
+  // ...
+```
+
+

That's it! Your app will be live on your Render URL as soon as the build finishes.

+

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/ro/publishing/index.html b/docs/ro/publishing/index.html new file mode 100644 index 0000000000..692b15182f --- /dev/null +++ b/docs/ro/publishing/index.html @@ -0,0 +1,374 @@ +Publishing your site · Docusaurus

1.12.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 ZEIT Now

+

Deploying your Docusaurus project to ZEIT Now will provide you with various benefits in the areas of performance and ease of use.

+

Most importantly, however, deploying a Docusaurus project only takes a couple seconds:

+
    +
  1. First, install their command-line interface:
    2. +
+
npm i -g now
+
+
    +
  1. Run a single command inside the root directory of your project:
    2. +
+
now
+
+

That's all. Your docs will automatically be deployed.

+

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

+
+

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 ZEIT Now

+

With ZEIT Now, you can deploy your site easily and connect it to GitHub or GitLab to automatically receive a new deployment every time you push a commit.

+

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:
    5. +
+
    +
  • For your build command enter: cd website; npm install; npm run build;
    • +
  • For publish directory: website/build/<projectName> (use the projectName from your siteConfig)
    • +
+
    +
  1. Click Deploy site
    2. +
+

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

+

Hosting on Render

+

Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploys from your Git repo. Deploy your app in just a few minutes by following these steps.

+
    +

  1. Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.

    2. +

  2. Select the branch to deploy. The default is master.

    3. +

  3. Enter the following values during creation.

    + + + + + + + + + +
    FieldValue
    EnvironmentStatic Site
    Build Commandcd website; yarn install; yarn build
    Publish Directorywebsite/build/<projectName>
    +
    4. +
+
`projectName` is the value you defined in your `siteConfig.js`.
+
+```javascript{7}
+const siteConfig = {
+  // ...
+  projectName: 'your-project-name',
+  // ...
+```
+
+

That's it! Your app will be live on your Render URL as soon as the build finishes.

+

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/ro/search.html b/docs/ro/search.html new file mode 100644 index 0000000000..a873ae81ce --- /dev/null +++ b/docs/ro/search.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.12.0

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/search/index.html b/docs/ro/search/index.html new file mode 100644 index 0000000000..a873ae81ce --- /dev/null +++ b/docs/ro/search/index.html @@ -0,0 +1,162 @@ +Enabling Search · Docusaurus

1.12.0

Translate

Enabling Search

Docusaurus suportă căutarea utilizând Algolia DocSearch. Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.

+

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

+

Activând bara de Căutare

+

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/ro/site-config.html b/docs/ro/site-config.html new file mode 100644 index 0000000000..2144825e32 --- /dev/null +++ b/docs/ro/site-config.html @@ -0,0 +1,404 @@ +siteConfig.js · Docusaurus

1.12.0

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+
+

To manage syntax extensions, use the markdownPlugins field.

+
+

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.

+

For example, if you want to enable superscript and subscript in your markdown that is rendered by Remarkable to HTML, you would do the following:

+
  markdownPlugins: [
+    function foo(md) {
+      md.inline.ruler.enable(['sub', 'sup']);
+    },
+  ],
+
+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/site-config/index.html b/docs/ro/site-config/index.html new file mode 100644 index 0000000000..2144825e32 --- /dev/null +++ b/docs/ro/site-config/index.html @@ -0,0 +1,404 @@ +siteConfig.js · Docusaurus

1.12.0

Translate

siteConfig.js

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

+

Vitrina utilizatorului

+

Array-ul utilizatori este folosit pentru a stoca obiecte pentru fiecare proiect pe care vrei să îl arăți pe site-ul tău. Currently, this field is used by example the pages/en/index.js and pages/en/users.js files provided. Orice obiect al utilizatorului are câmpuri caption, imagine, linkinformații și fixate. 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. Câmpul fixate determină dacă este afișat sau nu pe pagina index.

+

Currently, this users array is used only by the index.js and users.js example files. Dacă nu dorești să ai o pagină a utilizatorilor sau să arați utilizatorii pe pagina index poți sa elimini această secțiune.

+

Câmpurile siteConfig

+

Obiectul siteConfig conţine majoritatea setărilor de configurare pentru site-ul tău web.

+

Câmpuri obligatorii

+

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.

+
    +
  • culoarePrimară este culoarea folosită de bara de navigaţie a header-ului şi a sidebar-urilor.
    • +
  • culoareSecundară este culoarea vazută în al doilea rând al bării de navigaţie a header-ului atunci când fereastra site-ului este restrânsă (inclusiv pe mobil).
    • +
  • Configuraţii de culori personalizate pot fi deasemenea adăugate. Spre exemplu, dacă stilurile utilizatorului sunt adăugate cu culori specificate ca $myColor, atunci adăugarea unui câmp culoareaMea la culori îţi va permite să configurezi uşor această culoare.
    • +
+

copyright [string]

+

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

+

favicon [string]

+

URL for site favicon.

+

headerIcon [string]

+

URL for icon used in the 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.

+

Exemplu de utilizare:

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

+

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

+

Câmpuri Opţionale

+

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 an 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 return 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]

+

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

+

markdownOptions [object]

+

Override default Remarkable options that will be used to render markdown.

+
+

To manage syntax extensions, use the markdownPlugins field.

+
+

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.

+

For example, if you want to enable superscript and subscript in your markdown that is rendered by Remarkable to HTML, you would do the following:

+
  markdownPlugins: [
+    function foo(md) {
+      md.inline.ruler.enable(['sub', 'sup']);
+    },
+  ],
+
+

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]

+

An 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 [array]

+

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]

+

An 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]

+

An 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/ro/site-creation.html b/docs/ro/site-creation.html new file mode 100644 index 0000000000..fb48dd678b --- /dev/null +++ b/docs/ro/site-creation.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/site-creation/index.html b/docs/ro/site-creation/index.html new file mode 100644 index 0000000000..fb48dd678b --- /dev/null +++ b/docs/ro/site-creation/index.html @@ -0,0 +1,183 @@ +Creating your site · Docusaurus

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

+

După instalare și preparare, mare parte din munca pentru a crea un site de bază pentru documentele tale este deja completă.

+

Structură Site

+

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

+
+

Crează-ți Site-ul tău de bază

+

Pentru a crea un site complet funcțional, trebuie doar să urmezi câțiva pași:

+
    +

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

Dacă nu adaugi documentația ta la fișierul sidebars.json, documentele vor fi redate, dar vor putea avea link-uri numai din alte documentații și să fie vizitate cu URL-ul cunoscut.

+
+
    +
  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. Rulează site-ul pentru a vedea rezultatele schimbărilor tale.
    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/ro/site-preparation.html b/docs/ro/site-preparation.html new file mode 100644 index 0000000000..f9c4e712e9 --- /dev/null +++ b/docs/ro/site-preparation.html @@ -0,0 +1,151 @@ +Site Preparation · Docusaurus

1.12.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

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

1.12.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
+├── .gitignore
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── blog
+    │   ├── 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
+
+

Directory Descriptions

+
    +
  • Documentation Source Files: The docs directory contains example documentation files written in Markdown.
    • +
  • Blog: The website/blog 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 order of the documentation files.
    • +
  • .gitignore: The .gitignore file lists the necessary ignore files for the generated site so that they do not get added to the git repo.
    • +
+

Preparation Notes

+

You will need to keep the website/siteConfig.js and website/core/Footer.js files but may edit them as you wish. 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. 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.

+

If your directory does not yet have a .gitignore, we generate it with the necessary ignored files listed. As a general rule, you should ignore all node_modules, build files, system files (.DS_Store), logs, etc. Here is a more comprehensive list of what is normally ignored for Node.js projects.

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

1.12.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

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

1.12.0

Translate

Translations & Localization

Docusaurus allows for easy translation functionality using Crowdin. Fișierele de documentație scrise în engleză sunt încărcate pe Crowdin pentru o traducere a utilizatorilor din comunitate. Paginile de nivel înalt scrise cu șiruri în limba engleză pot fi traduse prin încercuirea tuturor șirurilor pe care vrei să le traduci într-un tag <traduce>. Alte titluri și etichete pot fi deasemenea găsite și traduse corespunzător.

+

Configurații traduceri Docusaurus

+

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

+
npm run exemple traduceri
+
+

sau

+
yarn exemple traduceri
+
+

Aceasta va crea următoarele fișiere:

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

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.

    • +
+

Traducând documentele tale existente

+

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.

+

Activând traducerile pe Pagini

+

Pages allow you to customize the layout and specific content of pages like a custom index page or help page.

+

Pages with text that you want translated should be placed in website/pages/en directory.

+

Încercuiește șirurile pe care vrei să le traduci într-un tag <traduce>, apoi adaugă următoarele declarații de tip require în capul fișierului:

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

Poţi deasemenea să incluzi un atribut de descriere opțională pentru a da mai mult context pentru un traducător despre cum să traducă acel șir:

+
<p>
+  <traduce desc="floare, nu verb">Rose</traduce>
+<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.

+
+

Adunând șirurile pentru a Traduce

+

Șirurile din paginile de localizare trebuiesc extrase și furnizate lui Crowdin.

+

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

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

Rulând acest script va genera un fișier siteweb/i18n/en.json conținând toate șirurile ce vor fi traduse din engleză în alte limbi.

+

Acest script include text din următoarele locuri:

+
    +
  • Șirurile titlu și etichetă_sidebar din header-ele de markdown ale documentului
    • +
  • nume categorii în sidebars.json
    • +
  • tagline în siteConfig.js
    • +
  • șirurile link header etichetă în siteConfig.js
    • +
  • șirurile încercuite în tag-ul <traduce> în orice fișier .js în interiorul pagini
    • +
+

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

+

Cum se traduc șirurile

+

Docusaurus însăși nu face nici o traducere dintr-o limbă în alta. În locul acesteia, el integrează Crowdin pentru a încărca traduceri și apoi descarcă fișierele respective traduse din Crowdin.

+

Cum folosește Docusaurus traducerile de șiruri

+

Această secțiune furnizează context despre cum funcționează traducerile în Docusaurus.

+

Șiruri

+

Un site Docusaurus are multe șiruri utilizate prin el care au nevoie de localizare. However, maintaining a list of strings used throughout a site can be laborious. Docusaurus simplifies this by centralizing strings.

+

The header navigation, for example, can have links to 'Home' or your 'Blog'. Aceasta sau alte șiruri găsite în header-ele și sidebar-urile paginilor sunt extrase și plasate în i18n/en.json. When your files are translated, say into Spanish, an i18n/es-ES.json file will be downloaded from Crowdin. Apoi, când paginile în spaniolă sunt generate, Docusaurus va înlocui versiunea în engleză a șirurilor corespunzătoare cu șirurile traduse din fișierul de localizare cu șiruri corespunzător (ex. Într-un site cu spaniola activată 'Help' va deveni 'Ayuda').

+

Fișiere Markdown

+

Pentru fișierele de documentație însăși, versiunile traduse așe acestor fișiere sunt descărcate și apoi redate prin template-ul de layout corespunzător.

+

Alte pagini

+

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. Poți să folosești Ghiduri-le Crowdin pentru a afla mai multe despre work flow-ul traducerilor. 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"
+},
+
+

Sincronizare fișier manuală

+

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

Comanda crowdin utilizează fișierul crowdin.yaml generat cu script-ul exemple. Ar trebuii plasat în directorul proiectului tău pentru a configura cum și ce fișiere sunt încărcate/descărcate.

+

Ia aminte că în fișierul crowdin.yaml, CROWDIN_PROJECT_ID și CROWDIN_API_KEY sunt variabile de environment setate în Circle pentru proiectul tău Crowdin. Pot fi găsite în setările proiectului tău Crowdin.

+

Acum, Circle te va ajuta să iei traducerile automat înainte să îți construiești site-ul web. Fișierul crowdin.yaml furnizat va copia documentele traduse în siteweb/documente_traduse/, și versiunile traduse a fișierului de șiruri i18n/en.json în i18n/${language}.json.

+

Dacă dorești să utilizezi Crowdin pe server-ul tău local, poți să instalezi unealta Crodin CLI și să rulezi aceleași comenzi găsite în fișierul circle.yaml. Singura diferență este ca trebuie să setezi valorile project_identifier și api_key în fișierul crowdin.yaml, din moment ce nu vei avea variabilele de environment Circle de setat.

+

Traduceri versionate

+

Dacă dorești să ai traducere și versionare pentru documentația ta, adaugă următoarea secțiune la finalul fișierului tău crowdin.yaml:

+
  -
+    sursă: '/siteweb/documente_versionate/**/*.md'
+    traducere: '/siteweb/documente_traduses/%locale%/**/%original_file_name%'
+    mapping_limbi: *anchor
+
+

Documentele traduse, versionate vor fi copiate în siteweb/documente_traduse/${language}/${version}/.

+
← Navigation and SidebarsVersioning →
\ No newline at end of file diff --git a/docs/ro/tutorial-create-new-site.html b/docs/ro/tutorial-create-new-site.html new file mode 100644 index 0000000000..1a4699cf9c --- /dev/null +++ b/docs/ro/tutorial-create-new-site.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.12.0

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/tutorial-create-new-site/index.html b/docs/ro/tutorial-create-new-site/index.html new file mode 100644 index 0000000000..1a4699cf9c --- /dev/null +++ b/docs/ro/tutorial-create-new-site/index.html @@ -0,0 +1,162 @@ +Create a New Site · Docusaurus

1.12.0

Translate

Create a New Site

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

+

Docusaurus browser

+

Scaffold the Site

+
    +
  1. Execute the docusaurus-init command in your terminal.
    2. +
+
docusaurus-init
+
+
+

The Linking dependencies... step might take a while, but it will finish eventually.

+
+

The following contents will be created in your current directory. Some example documentation pages (under docs) and blog posts (under website/blog) are included.

+
├── Dockerfile
+├── docker-compose.yml
+├── docs
+│   ├── doc1.md
+│   ├── doc2.md
+│   ├── doc3.md
+│   ├── exampledoc4.md
+│   └── exampledoc5.md
+└── website
+    ├── README.md
+    ├── blog
+    │   ├── 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
+    │   └── en
+    │       ├── help.js
+    │       ├── index.js
+    │       └── users.js
+    ├── sidebars.json
+    ├── siteConfig.js
+    ├── static
+    │   ├── css
+    │   │   └── custom.css
+    │   └── img
+    │       ├── docusaurus.svg
+    │       ├── favicon
+    │       │   └── favicon.ico
+    │       ├── favicon.png
+    │       └── oss_logo.png
+    └── yarn.lock
+
+
    +
  1. Run cd website to go into the website directory.
    2. +
  2. Run npm start or yarn start.
    3. +
+

A browser window will open up at http://localhost:3000.

+

Congratulations, you have just made your first Docusaurus site! Click around the pages to get a feel for it.

+
← Setting UpCreate Pages →
\ No newline at end of file diff --git a/docs/ro/tutorial-create-pages.html b/docs/ro/tutorial-create-pages.html new file mode 100644 index 0000000000..0839304898 --- /dev/null +++ b/docs/ro/tutorial-create-pages.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.12.0

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/tutorial-create-pages/index.html b/docs/ro/tutorial-create-pages/index.html new file mode 100644 index 0000000000..0839304898 --- /dev/null +++ b/docs/ro/tutorial-create-pages/index.html @@ -0,0 +1,181 @@ +Create Pages · Docusaurus

1.12.0

Translate

Create Pages

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

+

Docusaurus MacBook

+

Creating a Regular Page

+
    +

  1. Go into the pages/en directory and create a file called hello-world.js with the following contents:

    +

    const React = require('react');

    +

    const CompLibrary = require('../../core/CompLibrary.js');

    +

    const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock;

    +

    function HelloWorld(props) { +return ( +

    + +

    Hello World!

    +

    This is my first page!

    +     +
    +); +}

    +

    module.exports = HelloWorld;

    2. +
+
    +
  1. Go to http://localhost:3000/hello-world and you should be able to see the new page.
    2. +
  2. Change the text within the <p>...</p> to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
    3. +
+
- <p>This is my first page!</p>
++ <p>I can write JSX here!</p>
+
+

React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages here.

+

Docusaurus React

+

Create a Documentation Page

+
    +

  1. Create a new file in the docs folder called doc4.md. The docs folder is in the root of your Docusaurus project, one level above website.

    2. +

  2. Paste the following contents:

    +
    +

    id: doc4 +title: This is Doc 4

    +
    +

    I can write content using GitHub-flavored Markdown syntax.

    +

    Markdown Syntax

    +

    Bold italic code Links

    +
    +

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +id sem consectetuer libero luctus adipiscing.

    +
    +
      +
    • Hey
      • +
    • Ho
      • +
    • Let's Go
      • +
    3. +
+
    +
  1. The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc4" after "doc1". This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file.
    2. +
+
{
+  "docs": {
+    "Docusaurus": [
+      "doc1",
++     "doc4"
+    ],
+    "First Category": ["doc2"],
+    "Second Category": ["doc3"]
+  },
+  "docs-other": {
+    "First Category": ["doc4", "doc5"]
+  }
+}
+
+
    +
  1. A server restart is needed to pick up sidebar changes, so kill your dev server (Cmd + C or Ctrl + C) and restart it with npm run start.
    2. +
  2. Navigate to http://localhost:3000/docs/doc4.
    3. +
+

You've created your first documentation page on Docusaurus!

+

Learn more about creating docs pages here.

+
← Create a New SitePublish the Site →
\ No newline at end of file diff --git a/docs/ro/tutorial-publish-site.html b/docs/ro/tutorial-publish-site.html new file mode 100644 index 0000000000..a1361f5015 --- /dev/null +++ b/docs/ro/tutorial-publish-site.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.12.0

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/tutorial-publish-site/index.html b/docs/ro/tutorial-publish-site/index.html new file mode 100644 index 0000000000..a1361f5015 --- /dev/null +++ b/docs/ro/tutorial-publish-site/index.html @@ -0,0 +1,133 @@ +Publish the Site · Docusaurus

1.12.0

Translate

Publish the Site

Docusaurus Facebook

+

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

+

Put the Site Online

+

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

+

In website/siteConfig.js, fill in the following fields:

+
const siteConfig = {
+  ...
+  url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
+  baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
+  projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
+  organizationName: 'USERNAME' // Your GitHub username.
+  ...
+}
+
+
    +

  1. In the website directory, run npm run build or yarn 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. Make sure the build directory is there before running the next step.

    2. +

  2. Replace <GIT_USER> with your GitHub username and run the following command.

    +

    $ GIT_USER=<GIT_USER> CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

    3. +
+

The built code will be pushed to the gh-pages branch of your repository.

+
    +
  1. Go to https://USERNAME.github.io/docusaurus-tutorial/ and view your site in action!
    2. +
+
+

Note that when you run npm run start again, the baseUrl will now be part of the path.

+
+
← Create PagesAdd Versions →
\ No newline at end of file diff --git a/docs/ro/tutorial-setup.html b/docs/ro/tutorial-setup.html new file mode 100644 index 0000000000..00865944d5 --- /dev/null +++ b/docs/ro/tutorial-setup.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.12.0

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/tutorial-setup/index.html b/docs/ro/tutorial-setup/index.html new file mode 100644 index 0000000000..00865944d5 --- /dev/null +++ b/docs/ro/tutorial-setup/index.html @@ -0,0 +1,162 @@ +Setting Up · Docusaurus

1.12.0

Translate

Setting Up

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

+

Docusaurus campfire

+

Install Node.js

+

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

+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+
+
    +
  1. Open your Terminal.
    2. +
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
+
brew install node
+
+

Alternatively, you can download an installer from the Node.js homepage.

+

Check your Node.js installation

+

Check that you have the minimum required version installed by running the following command:

+
node -v
+
+

You should see a version larger than Node 8.

+
node -v
+v8.15.1
+
+

Install Yarn (Optional)

+

We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

+
+

You can still proceed with the tutorial without Yarn.

+
+

Create a GitHub Repository

+
    +
  1. Go to https://github.com/ and sign up for an account if you don't already have one.
    2. +
  2. Click on "New Repository" or go to https://github.com/new.
    3. +
  3. Name your repository without spaces. For e.g. docusaurus-tutorial.
    4. +
  4. Proceed to create the repository without adding .gitignore or a license.
    5. +
+

GitHub create repo

+
    +
  1. Clone your repository to your local machine:
    2. +
+
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
+# or
+git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
+
+
    +
  1. cd into the repository which you just created.
    2. +
+

Install the Docusaurus init command

+

Docusaurus comes with a command line tool to help you scaffold a Docusaurus site with some example templates. Let's install the installer!

+
    +
  1. Run the following command:
    2. +
+
npm install --global docusaurus-init
+
+

or if you have Yarn:

+
yarn global add docusaurus-init
+
+
Create a New Site →
\ No newline at end of file diff --git a/docs/ro/tutorial-version.html b/docs/ro/tutorial-version.html new file mode 100644 index 0000000000..f77a0e2a75 --- /dev/null +++ b/docs/ro/tutorial-version.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.12.0

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/tutorial-version/index.html b/docs/ro/tutorial-version/index.html new file mode 100644 index 0000000000..f77a0e2a75 --- /dev/null +++ b/docs/ro/tutorial-version/index.html @@ -0,0 +1,139 @@ +Add Versions · Docusaurus

1.12.0

Translate

Add Versions

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

+

Docusaurus process

+

Releasing a Version

+

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

+
npm run examples versions # yarn examples versions
+
+

Next, we run a command with the version we want to create, e.g. 1.0.0,

+
npm run version 1.0.0 # yarn 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.

+

Documents in the docs directory will be considered part of version next and they are available, for example, at the URL localhost:3000/<baseUrl>/docs/next/doc1. Documents from the latest version use the URL docs/doc1.

+

Let's test out that versioning actually works. We can go to docs/doc1.md and change the first line of the body:

+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Example Page
+---
+
+- Check the [documentation](https://docusaurus.io) for how to use Docusaurus.
++ This is the latest version of the docs.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+

If we go to the localhost:3000/<baseUrl>/docs/doc1 URL in our browser, realize that it's still showing the previous line. That's because the version we're looking at now is the 1.0.0 version, which has already been frozen in time.

+

Next Version

+

The latest versions of the docs have to be accessed by adding next to the URL: localhost:3000/<baseUrl>/docs/next/doc1. Note that the version beside the title also changes to next when we are on that URL.

+

A versions page has been created for us at localhost:3000/<baseUrl>/versions which shows a list of the current versions of the documentation. See that both 1.0.0 and master are being listed here and they correctly link to the respective versions of the documentation.

+

Go ahead and publish your versioned site!

+

Wrap Up

+

That's all folks! In this short tutorial, you have experienced how easy it was to create a documentation website from scratch and making versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the Guides section for more.

+
← Publish the Site
\ No newline at end of file diff --git a/docs/ro/versioning.html b/docs/ro/versioning.html new file mode 100644 index 0000000000..0c27c834a2 --- /dev/null +++ b/docs/ro/versioning.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ro/versioning/index.html b/docs/ro/versioning/index.html new file mode 100644 index 0000000000..0c27c834a2 --- /dev/null +++ b/docs/ro/versioning/index.html @@ -0,0 +1,164 @@ +Versioning · Docusaurus

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

+

Cum să creezi versiuni noi

+

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
+

Tipare de versionare

+

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.

+

Fișiere de stocare pentru fiecare versiune

+

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.

+

Funcționalitate Fallback

+

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.

+

Redenuming versiunile existente

+

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

Versionări și Traduceri

+

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/ru/1.10.x/doc-markdown.html b/docs/ru/1.10.x/doc-markdown.html index 6ad4778bf3..41e8c0be4c 100644 --- a/docs/ru/1.10.x/doc-markdown.html +++ b/docs/ru/1.10.x/doc-markdown.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/1.10.x/doc-markdown/index.html b/docs/ru/1.10.x/doc-markdown/index.html index 6ad4778bf3..41e8c0be4c 100644 --- a/docs/ru/1.10.x/doc-markdown/index.html +++ b/docs/ru/1.10.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/1.11.x/doc-markdown.html b/docs/ru/1.11.x/doc-markdown.html index 1a5efdc022..9e07f76731 100644 --- a/docs/ru/1.11.x/doc-markdown.html +++ b/docs/ru/1.11.x/doc-markdown.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/1.11.x/doc-markdown/index.html b/docs/ru/1.11.x/doc-markdown/index.html index 1a5efdc022..9e07f76731 100644 --- a/docs/ru/1.11.x/doc-markdown/index.html +++ b/docs/ru/1.11.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/1.9.x/doc-markdown.html b/docs/ru/1.9.x/doc-markdown.html index 3c01d6abf9..101dd8a3a8 100644 --- a/docs/ru/1.9.x/doc-markdown.html +++ b/docs/ru/1.9.x/doc-markdown.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/1.9.x/doc-markdown/index.html b/docs/ru/1.9.x/doc-markdown/index.html index 3c01d6abf9..101dd8a3a8 100644 --- a/docs/ru/1.9.x/doc-markdown/index.html +++ b/docs/ru/1.9.x/doc-markdown/index.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/doc-markdown.html b/docs/ru/doc-markdown.html index 70c79903c3..5f425f1941 100644 --- a/docs/ru/doc-markdown.html +++ b/docs/ru/doc-markdown.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/doc-markdown/index.html b/docs/ru/doc-markdown/index.html index 70c79903c3..5f425f1941 100644 --- a/docs/ru/doc-markdown/index.html +++ b/docs/ru/doc-markdown/index.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/next/doc-markdown.html b/docs/ru/next/doc-markdown.html index 9557a2a53b..aebc8ff8dc 100644 --- a/docs/ru/next/doc-markdown.html +++ b/docs/ru/next/doc-markdown.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/next/doc-markdown/index.html b/docs/ru/next/doc-markdown/index.html index 9557a2a53b..aebc8ff8dc 100644 --- a/docs/ru/next/doc-markdown/index.html +++ b/docs/ru/next/doc-markdown/index.html @@ -162,10 +162,10 @@ Text describing my function

Добавив следующий код в свой файл Markdown:

вы получите это:

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

Подсветка синтаксиса

Подсветка синтаксиса включена по-умолчанию для огороженных блоков кода. Язык будет определен автоматически, но в некоторых случаях вы можете добиться лучшего результата, указав язык самостоятельно. Вы можете этого добиться, используя строку информации, следующую за тремя открывающими обратными кавычками. Следующий код JavaScript...

diff --git a/docs/ru/next/tutorial-setup.html b/docs/ru/next/tutorial-setup.html index b1b8f84206..af8d58aca0 100644 --- a/docs/ru/next/tutorial-setup.html +++ b/docs/ru/next/tutorial-setup.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/ru/next/tutorial-setup/index.html b/docs/ru/next/tutorial-setup/index.html index b1b8f84206..af8d58aca0 100644 --- a/docs/ru/next/tutorial-setup/index.html +++ b/docs/ru/next/tutorial-setup/index.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/zh-CN/1.10.x/doc-markdown.html b/docs/zh-CN/1.10.x/doc-markdown.html index b34ec80017..740d35f968 100644 --- a/docs/zh-CN/1.10.x/doc-markdown.html +++ b/docs/zh-CN/1.10.x/doc-markdown.html @@ -162,10 +162,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/zh-CN/1.10.x/doc-markdown/index.html b/docs/zh-CN/1.10.x/doc-markdown/index.html index b34ec80017..740d35f968 100644 --- a/docs/zh-CN/1.10.x/doc-markdown/index.html +++ b/docs/zh-CN/1.10.x/doc-markdown/index.html @@ -162,10 +162,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/zh-CN/1.11.x/doc-markdown.html b/docs/zh-CN/1.11.x/doc-markdown.html index 6d17b8e093..66c371f0d0 100644 --- a/docs/zh-CN/1.11.x/doc-markdown.html +++ b/docs/zh-CN/1.11.x/doc-markdown.html @@ -162,10 +162,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/zh-CN/1.11.x/doc-markdown/index.html b/docs/zh-CN/1.11.x/doc-markdown/index.html index 6d17b8e093..66c371f0d0 100644 --- a/docs/zh-CN/1.11.x/doc-markdown/index.html +++ b/docs/zh-CN/1.11.x/doc-markdown/index.html @@ -162,10 +162,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/zh-CN/1.9.x/doc-markdown.html b/docs/zh-CN/1.9.x/doc-markdown.html index 83d162de66..ee0e6281ff 100644 --- a/docs/zh-CN/1.9.x/doc-markdown.html +++ b/docs/zh-CN/1.9.x/doc-markdown.html @@ -162,10 +162,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/zh-CN/1.9.x/doc-markdown/index.html b/docs/zh-CN/1.9.x/doc-markdown/index.html index 83d162de66..ee0e6281ff 100644 --- a/docs/zh-CN/1.9.x/doc-markdown/index.html +++ b/docs/zh-CN/1.9.x/doc-markdown/index.html @@ -162,10 +162,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/zh-CN/doc-markdown.html b/docs/zh-CN/doc-markdown.html index 099933050c..0f8e2c6c18 100644 --- a/docs/zh-CN/doc-markdown.html +++ b/docs/zh-CN/doc-markdown.html @@ -162,10 +162,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/zh-CN/doc-markdown/index.html b/docs/zh-CN/doc-markdown/index.html index 099933050c..0f8e2c6c18 100644 --- a/docs/zh-CN/doc-markdown/index.html +++ b/docs/zh-CN/doc-markdown/index.html @@ -162,10 +162,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/zh-CN/next/doc-markdown.html b/docs/zh-CN/next/doc-markdown.html index 94aa3055be..74e6e1cd0d 100644 --- a/docs/zh-CN/next/doc-markdown.html +++ b/docs/zh-CN/next/doc-markdown.html @@ -162,10 +162,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/zh-CN/next/doc-markdown/index.html b/docs/zh-CN/next/doc-markdown/index.html index 94aa3055be..74e6e1cd0d 100644 --- a/docs/zh-CN/next/doc-markdown/index.html +++ b/docs/zh-CN/next/doc-markdown/index.html @@ -162,10 +162,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/zh-CN/next/tutorial-setup.html b/docs/zh-CN/next/tutorial-setup.html index 7f422918d5..fc2cb390ee 100644 --- a/docs/zh-CN/next/tutorial-setup.html +++ b/docs/zh-CN/next/tutorial-setup.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/docs/zh-CN/next/tutorial-setup/index.html b/docs/zh-CN/next/tutorial-setup/index.html index 7f422918d5..fc2cb390ee 100644 --- a/docs/zh-CN/next/tutorial-setup/index.html +++ b/docs/zh-CN/next/tutorial-setup/index.html @@ -85,13 +85,10 @@

Install Git

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

Install Node.js

-

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

-
-

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

-
+

Node.js is an environment that can run JavaScript code outside of a web browser and is used to write and run server-side JavaScript apps. Node.js installation includes npm, the package manager that allows you to install NPM modules from your terminal.

  1. Open your Terminal.
    2. -
  2. If you have brew on your OS, run the following command to install Node (a JavaScript runtime that allows you to run JavaScript on the server) and npm the package manager (allows you to install npm modules from your terminal).
    3. +
  3. If you have brew on your OS, run the following command to install Node.
brew install node
@@ -104,6 +101,9 @@ 
node -v
 v8.15.1
+
+

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

+

Install Yarn (Optional)

We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out here.

diff --git a/ro/about-slash.html b/ro/about-slash.html index cafd31809d..019ca78b9d 100644 --- a/ro/about-slash.html +++ b/ro/about-slash.html @@ -1,4 +1,4 @@ -About Slash · Docusaurus