Pour publier dans le blog, créez un fichier dans le dossier du blog avec un nom au format AAAA-MM-JJ-Mon-Blog-Billet-Titre.md. La date de publication est extraite du nom du fichier.
+
Par exemple, dans website/blog/2017-12-14-Introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
Options d'entête
+
Le seul champ requis est title, cependant, nous fournissons des options pour ajouter des informations sur l'auteur à votre blog ainsi que d'autres options.
+
+
author - L'étiquette du texte de l'auteur par ligne.
+
authorURL - L'URL associée à l'auteur. Ceci pourrait être un compte Twitter, GitHub, Facebook, etc.
+
authorFBID - L'ID de profil Facebook qui est utilisé pour récupérer l'image de profil.
+
authorImageURL - L'URL vers l'image de l'auteur. (Remarque : Si vous utilisez à la fois authorFBID et authorImageURL, authorFBID prendra la priorité. N’incluez pas authorFBID si vous voulez que authorImageURL apparaisse.)
+
title - Le titre de l'article du blog.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
unlisted - L'article sera accessible en visitant directement l'URL mais ne s'affichera pas dans la barre latérale de la version finale; pendant le développement local, l'article sera toujours listé. Utile dans les situations où vous voulez partager un article en cours de construction avec d'autres personnes pour les commentaires.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
Résumé de l'article
+
Utilisez le marqueur <!--truncate--> dans votre message de blog pour représenter ce qui sera affiché comme résumé lors de l'affichage de tous les articles de blog publiés. Tout ce qui précède <!--truncate--> fera partie du résumé. Par exemple :
Changer le nombre de messages du blog sur la barre latérale
+
Par défaut, 5 messages récents sont affichés sur la barre latérale.
+
Vous pouvez configurer un nombre spécifique de messages de blog à afficher en ajoutant un paramètre blogSidebarCount à votre siteConfig.js.
+
Les options disponibles sont un entier représentant le nombre de messages à afficher ou une chaîne avec la valeur 'ALL'.
+
Exemple :
+
blogSidebarCount: 'ALL',
+
+
Changer le titre de la barre latérale
+
Vous pouvez configurer un titre de barre latérale spécifique en ajoutant un paramètre blogSidebarTitle à votre siteConfig.js.
+
L'option est un objet qui peut avoir les clés default et all. Spécifier une valeur pour default vous permet de changer le titre par défaut de la barre latérale. Spécifier une valeur pour all vous permet de changer le titre de la barre latérale lorsque l'option blogSidebarCount est définie à 'ALL'.
+
Exemple :
+
blogSidebarTitle : { default: 'Articles récents', all: 'Tous les articles du blog' },
+
+
Flux RSS
+
Docusaurus fournit un flux RSS pour vos articles de blog. Les formats de flux RSS et Atom sont pris en charge. Ces données sont automatiquement ajoutées sur le tag HTML <HEAD> de votre page web.
+
Un résumé du texte du message est fourni dans le flux RSS depuis <!--truncate-->. If no <!--truncate--> tag is found, then all text up to 250 characters are used.
+
Boutons de réseaux sociaux
+
Si vous voulez des boutons sociaux Facebook et/ou Twitter au bas de vos articles de blog, définissez les options facebookAppId et/ou twitter de la configuration du site dans siteConfig.js.
+
Sujets avancés
+
Je veux exécuter en mode "Blog uniquement".
+
Vous pouvez exécuter votre site Docusaurus sans page d'accueil et avoir en premier votre blog.
+
Pour faire cela :
+
+
Créer un fichier index.html dans website/static/.
+
Placez le contenu du modèle ci-dessous dans website/static/index.html
+
Personnaliser <title> de site/static/index.html
+
Supprimer la page d'accueil dynamique website/pages/fr/index.js
+
+
+
Maintenant, lorsque Docusaurus génère ou construit votre site, il copiera le fichier de static/index.html et le placera dans le répertoire principal du site. Le fichier statique est utilisé lorsqu'un visiteur arrive sur votre page. Lorsque la page charge, elle redirigera le visiteur vers /blog.
+
+
Vous pouvez utiliser ce modèle :
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/fr/adding-blog/index.html b/docs/fr/adding-blog/index.html
new file mode 100644
index 0000000000..27674f7156
--- /dev/null
+++ b/docs/fr/adding-blog/index.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
Pour publier dans le blog, créez un fichier dans le dossier du blog avec un nom au format AAAA-MM-JJ-Mon-Blog-Billet-Titre.md. La date de publication est extraite du nom du fichier.
+
Par exemple, dans website/blog/2017-12-14-Introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
Options d'entête
+
Le seul champ requis est title, cependant, nous fournissons des options pour ajouter des informations sur l'auteur à votre blog ainsi que d'autres options.
+
+
author - L'étiquette du texte de l'auteur par ligne.
+
authorURL - L'URL associée à l'auteur. Ceci pourrait être un compte Twitter, GitHub, Facebook, etc.
+
authorFBID - L'ID de profil Facebook qui est utilisé pour récupérer l'image de profil.
+
authorImageURL - L'URL vers l'image de l'auteur. (Remarque : Si vous utilisez à la fois authorFBID et authorImageURL, authorFBID prendra la priorité. N’incluez pas authorFBID si vous voulez que authorImageURL apparaisse.)
+
title - Le titre de l'article du blog.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
unlisted - L'article sera accessible en visitant directement l'URL mais ne s'affichera pas dans la barre latérale de la version finale; pendant le développement local, l'article sera toujours listé. Utile dans les situations où vous voulez partager un article en cours de construction avec d'autres personnes pour les commentaires.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
Résumé de l'article
+
Utilisez le marqueur <!--truncate--> dans votre message de blog pour représenter ce qui sera affiché comme résumé lors de l'affichage de tous les articles de blog publiés. Tout ce qui précède <!--truncate--> fera partie du résumé. Par exemple :
Changer le nombre de messages du blog sur la barre latérale
+
Par défaut, 5 messages récents sont affichés sur la barre latérale.
+
Vous pouvez configurer un nombre spécifique de messages de blog à afficher en ajoutant un paramètre blogSidebarCount à votre siteConfig.js.
+
Les options disponibles sont un entier représentant le nombre de messages à afficher ou une chaîne avec la valeur 'ALL'.
+
Exemple :
+
blogSidebarCount: 'ALL',
+
+
Changer le titre de la barre latérale
+
Vous pouvez configurer un titre de barre latérale spécifique en ajoutant un paramètre blogSidebarTitle à votre siteConfig.js.
+
L'option est un objet qui peut avoir les clés default et all. Spécifier une valeur pour default vous permet de changer le titre par défaut de la barre latérale. Spécifier une valeur pour all vous permet de changer le titre de la barre latérale lorsque l'option blogSidebarCount est définie à 'ALL'.
+
Exemple :
+
blogSidebarTitle : { default: 'Articles récents', all: 'Tous les articles du blog' },
+
+
Flux RSS
+
Docusaurus fournit un flux RSS pour vos articles de blog. Les formats de flux RSS et Atom sont pris en charge. Ces données sont automatiquement ajoutées sur le tag HTML <HEAD> de votre page web.
+
Un résumé du texte du message est fourni dans le flux RSS depuis <!--truncate-->. If no <!--truncate--> tag is found, then all text up to 250 characters are used.
+
Boutons de réseaux sociaux
+
Si vous voulez des boutons sociaux Facebook et/ou Twitter au bas de vos articles de blog, définissez les options facebookAppId et/ou twitter de la configuration du site dans siteConfig.js.
+
Sujets avancés
+
Je veux exécuter en mode "Blog uniquement".
+
Vous pouvez exécuter votre site Docusaurus sans page d'accueil et avoir en premier votre blog.
+
Pour faire cela :
+
+
Créer un fichier index.html dans website/static/.
+
Placez le contenu du modèle ci-dessous dans website/static/index.html
+
Personnaliser <title> de site/static/index.html
+
Supprimer la page d'accueil dynamique website/pages/fr/index.js
+
+
+
Maintenant, lorsque Docusaurus génère ou construit votre site, il copiera le fichier de static/index.html et le placera dans le répertoire principal du site. Le fichier statique est utilisé lorsqu'un visiteur arrive sur votre page. Lorsque la page charge, elle redirigera le visiteur vers /blog.
+
+
Vous pouvez utiliser ce modèle :
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/fr/docker.html b/docs/fr/docker.html
new file mode 100644
index 0000000000..11d6e8a583
--- /dev/null
+++ b/docs/fr/docker.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
Docker est un outil qui vous permet de créer, déployer et gérer des paquets légers et autonomes qui contiennent tout ce qui est nécessaire pour exécuter une application. Il peut aider à éviter les dépendances conflictuelles et les comportements indésirables lors de l'exécution de Docusaurus.
Build the docker image -- Enter the folder where you have Docusaurus installed. Exécutez build docker -t docusaurus-doc .
+
Une fois la phase de construction terminée, vous pouvez vérifier que l'image existe en exécutant docker images.
+
+
Nous incluons maintenant un Dockerfile lorsque vous installez Docusaurus.
+
+
Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc
+
Ceci démarrera un conteneur docker avec l'image docusaurus-doc. Pour voir plus d'informations détaillées sur les conteneurs, exécutez docker ps .
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
Utiliser docker-compose
+
Nous pouvons également utiliser docker-compose pour configurer notre application. Cette fonctionnalité de docker vous permet d'exécuter le serveur web et tout autre service avec une seule commande.
+
+
Compose est un outil pour définir et exécuter les applications Docker multi-conteneurs. Avec Compose, vous utilisez un fichier YAML pour configurer les services de votre application. Ensuite, avec une seule commande, vous créez et démarrez tous les services de votre configuration.
+
+
L'utilisation de Compose est un processus à trois étapes :
+
+
Définissez l'environnement de votre application avec un Dockerfile pour qu'il puisse être reproduit n'importe où.
+
Définissez les services qui composent votre application dans docker-compose.yml afin qu'ils puissent être exécutés ensemble dans un environnement isolé.
+
Exécutez docker-compose et Compose démarre et exécute toute votre application.
+
+
Nous incluons un docker-compose.yml de base dans votre projet :
\ No newline at end of file
diff --git a/docs/fr/docker/index.html b/docs/fr/docker/index.html
new file mode 100644
index 0000000000..11d6e8a583
--- /dev/null
+++ b/docs/fr/docker/index.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
Docker est un outil qui vous permet de créer, déployer et gérer des paquets légers et autonomes qui contiennent tout ce qui est nécessaire pour exécuter une application. Il peut aider à éviter les dépendances conflictuelles et les comportements indésirables lors de l'exécution de Docusaurus.
Build the docker image -- Enter the folder where you have Docusaurus installed. Exécutez build docker -t docusaurus-doc .
+
Une fois la phase de construction terminée, vous pouvez vérifier que l'image existe en exécutant docker images.
+
+
Nous incluons maintenant un Dockerfile lorsque vous installez Docusaurus.
+
+
Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc
+
Ceci démarrera un conteneur docker avec l'image docusaurus-doc. Pour voir plus d'informations détaillées sur les conteneurs, exécutez docker ps .
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
Utiliser docker-compose
+
Nous pouvons également utiliser docker-compose pour configurer notre application. Cette fonctionnalité de docker vous permet d'exécuter le serveur web et tout autre service avec une seule commande.
+
+
Compose est un outil pour définir et exécuter les applications Docker multi-conteneurs. Avec Compose, vous utilisez un fichier YAML pour configurer les services de votre application. Ensuite, avec une seule commande, vous créez et démarrez tous les services de votre configuration.
+
+
L'utilisation de Compose est un processus à trois étapes :
+
+
Définissez l'environnement de votre application avec un Dockerfile pour qu'il puisse être reproduit n'importe où.
+
Définissez les services qui composent votre application dans docker-compose.yml afin qu'ils puissent être exécutés ensemble dans un environnement isolé.
+
Exécutez docker-compose et Compose démarre et exécute toute votre application.
+
+
Nous incluons un docker-compose.yml de base dans votre projet :
\ No newline at end of file
diff --git a/docs/fr/installation.html b/docs/fr/installation.html
new file mode 100644
index 0000000000..15948deee2
--- /dev/null
+++ b/docs/fr/installation.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
Docusaurus a été conçu dans l'optique d'être facilement installable et utilisable pour que votre site web soit rapidement opérationnel.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Installation de Docusaurus
+
Nous avons créé un script utile qui vous permettra de configurer toutes les infrastructures :
+
+
Assurez-vous d'avoir la dernière version de Node d'installé. Nous vous recommandons également d'installer Yarn.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Créez un projet, si aucun n'existe, et placez votre répertoire courant à la racine du projet.
+
Vous pouvez créer la documentation dans ce dossier. Le répertoire racine peut contenir d'autres fichiers. Le script d'installation de Docusaurus vous créera deux nouveaux répertoires : docs et website.
+
+
Généralement, un projet GitHub existant ou nouvellement créé sera l'emplacement de votre site Docusaurus, mais ce n'est pas obligatoire pour utiliser Docusaurus.
+
+
Exécutez le script d'installation de Docusaurus : npx docusaurus-init.
+
+
Si vous n’avez pas node 8.2 + ou si vous préférez installer Docusaurus de manière globale, exécutez yarn global add docusaurus-init ou npm install --global docusaurus-init. Après, exécutez docusaurus-init.
+
+
+
Vérification de l'installation
+
Avec les répertoires et les fichiers déjà existants, votre répertoire racine contient maintenant une structure semblable à :
Cette installation crée des fichiers Docker qui ne sont pas nécessaires pour exécuter docusaurus. Ils peuvent être supprimés sans problème dans un souci d'économie de place. Pour plus d'informations sur Docker, veuillez consulter la documentation Docker.
+
+
Exécution du site web d'exemple
+
Après avoir exécuté le script d'initialisation Docusaurus, docusaurus-init comme décrit dans la section Installation, vous aurez un site web d'exemple à utiliser comme base de votre site. Pour se faire :
+
+
cd website
+
Depuis le répertoire website, exécutez le serveur web local en utilisant yarn start ou npm start.
+
Chargez le site d'exemple depuis l'adresse http://localhost:3000 s'il ne s'ouvre pas automatiquement. Si le port 3000 est déjà pris, un autre port sera utilisé. Regardez les messages de la console pour voir lequel.
+
Vous devriez voir le site d'exemple chargé dans votre navigateur Web. Il y a aussi un serveur LiveReload en cours d'exécution et toute modification apportée à la documentation et aux fichiers dans le répertoire website provoquera l'actualisation de la page. Une couleur de thème primaire et secondaire générée aléatoirement sera choisie pour vous.
+
+
+
Lancement du serveur derrière un proxy
+
Si vous êtes derrière un proxy, vous devez le désactiver durant l'utilisation du serveur de développement. Ceci peut être fait en utilisant la variable d'environnement NO_PROXY.
+
SET NO_PROXY=localhost
+yarn start (ou npm run start)
+
+
Mettre à jour votre version de Docusaurus
+
A tout moment, après avoir installé Docusaurus, vous pouvez vérifier votre version actuelle en allant dans le répertoire website et en écrivant yarn outdated docusaurus ou npm outdated docusaurus.
+
Vous verrez quelque chose comme ceci :
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
S'il n'y as pas de version visible sur la sortie de la commande outdated, vous êtes à jour.
+
+
Vous pouvez mettre à jour la dernière version de Docusaurus via :
+
yarn upgrade docusaurus --latest
+
+
ou
+
npm update docusaurus
+
+
+
Si vous obtenez une erreur après la mise à jour, essayez de nettoyer votre cache Babel (généralement il se trouve dans un dossier temporaire) ou lancer le serveur Docusaurus (par exemple yarn start avec le paramètre d'environnement BABEL_DISABLE_CACHE=1.
\ No newline at end of file
diff --git a/docs/fr/installation/index.html b/docs/fr/installation/index.html
new file mode 100644
index 0000000000..15948deee2
--- /dev/null
+++ b/docs/fr/installation/index.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
Docusaurus a été conçu dans l'optique d'être facilement installable et utilisable pour que votre site web soit rapidement opérationnel.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Installation de Docusaurus
+
Nous avons créé un script utile qui vous permettra de configurer toutes les infrastructures :
+
+
Assurez-vous d'avoir la dernière version de Node d'installé. Nous vous recommandons également d'installer Yarn.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Créez un projet, si aucun n'existe, et placez votre répertoire courant à la racine du projet.
+
Vous pouvez créer la documentation dans ce dossier. Le répertoire racine peut contenir d'autres fichiers. Le script d'installation de Docusaurus vous créera deux nouveaux répertoires : docs et website.
+
+
Généralement, un projet GitHub existant ou nouvellement créé sera l'emplacement de votre site Docusaurus, mais ce n'est pas obligatoire pour utiliser Docusaurus.
+
+
Exécutez le script d'installation de Docusaurus : npx docusaurus-init.
+
+
Si vous n’avez pas node 8.2 + ou si vous préférez installer Docusaurus de manière globale, exécutez yarn global add docusaurus-init ou npm install --global docusaurus-init. Après, exécutez docusaurus-init.
+
+
+
Vérification de l'installation
+
Avec les répertoires et les fichiers déjà existants, votre répertoire racine contient maintenant une structure semblable à :
Cette installation crée des fichiers Docker qui ne sont pas nécessaires pour exécuter docusaurus. Ils peuvent être supprimés sans problème dans un souci d'économie de place. Pour plus d'informations sur Docker, veuillez consulter la documentation Docker.
+
+
Exécution du site web d'exemple
+
Après avoir exécuté le script d'initialisation Docusaurus, docusaurus-init comme décrit dans la section Installation, vous aurez un site web d'exemple à utiliser comme base de votre site. Pour se faire :
+
+
cd website
+
Depuis le répertoire website, exécutez le serveur web local en utilisant yarn start ou npm start.
+
Chargez le site d'exemple depuis l'adresse http://localhost:3000 s'il ne s'ouvre pas automatiquement. Si le port 3000 est déjà pris, un autre port sera utilisé. Regardez les messages de la console pour voir lequel.
+
Vous devriez voir le site d'exemple chargé dans votre navigateur Web. Il y a aussi un serveur LiveReload en cours d'exécution et toute modification apportée à la documentation et aux fichiers dans le répertoire website provoquera l'actualisation de la page. Une couleur de thème primaire et secondaire générée aléatoirement sera choisie pour vous.
+
+
+
Lancement du serveur derrière un proxy
+
Si vous êtes derrière un proxy, vous devez le désactiver durant l'utilisation du serveur de développement. Ceci peut être fait en utilisant la variable d'environnement NO_PROXY.
+
SET NO_PROXY=localhost
+yarn start (ou npm run start)
+
+
Mettre à jour votre version de Docusaurus
+
A tout moment, après avoir installé Docusaurus, vous pouvez vérifier votre version actuelle en allant dans le répertoire website et en écrivant yarn outdated docusaurus ou npm outdated docusaurus.
+
Vous verrez quelque chose comme ceci :
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
S'il n'y as pas de version visible sur la sortie de la commande outdated, vous êtes à jour.
+
+
Vous pouvez mettre à jour la dernière version de Docusaurus via :
+
yarn upgrade docusaurus --latest
+
+
ou
+
npm update docusaurus
+
+
+
Si vous obtenez une erreur après la mise à jour, essayez de nettoyer votre cache Babel (généralement il se trouve dans un dossier temporaire) ou lancer le serveur Docusaurus (par exemple yarn start avec le paramètre d'environnement BABEL_DISABLE_CACHE=1.
\ No newline at end of file
diff --git a/docs/fr/publishing.html b/docs/fr/publishing.html
new file mode 100644
index 0000000000..511f160c4f
--- /dev/null
+++ b/docs/fr/publishing.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
Vous devez avoir maintenant un site fonctionnant localement. Une fois que vous l'avez personnalisé à votre gout, c'est le temps de le publier. Docusaurus génère un site web HTML statique qui est prêt à être servi par votre serveur web préféré ou une solution d'hébergement en ligne.
+
Création des pages HTML statiques
+
Pour créer une version statique de votre site web, exécutez le script suivant dans le dossier website:
+
yarn run build # ou `npm run build`
+
+
Cela va générer un dossier build dans le dossier website contenant les fichiers .html de toute votre documentation et d'autres pages incluses dans pages.
+
Hébergement de pages HTML statiques
+
À ce point, vous pouvez prendre tous les fichiers dans le dossier website/build et les copier dans votre dossier html de votre serveur web préféré.
+
+
Par exemple, Apache et Nginx diffuse le contenu à partir de /var/www/html par défaut. Cela dit, choisir un serveur web ou un hébergeur est à l'extérieur du cadre de Docusaurus.
+
+
+
Lorsque vous diffusez le site à partir de votre propre serveur web, assurez-vous que le serveur web fournit bien les fichiers de composants avec les entêtes HTTP appropriés. Les fichiers CSS doivent être servis avec l'entête content-type de text/css. Dans le cas de Nginx, cela signifierait le paramètre inclure /etc/nginx/mime.types; dans votre fichier nginx.conf . Consulter ce problème pour plus d'informations.
Exécutez une seule commande dans le répertoire racine de votre projet :
+
+
vercel
+
+
C'est tout. Vos docs seront automatiquement déployées.
+
+
Notez que la prise en charge de la structure de répertoire de Now est légèrement différente de la structure de répertoire par défaut d'un projet Docusaurus - Le répertoire docs doit être dans le répertoire website, suivant idéalement la structure des répertoires dans cet exemple. Vous devrez également spécifier une valeur customDocsPath dans siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Utilisation de Github Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
Même si votre dépôt est privé, tout ce qui est publié dans une branche gh-pages sera public.
+
+
Remarque : Lorsque vous déployez en tant qu'utilisateur/organisation des pages, le script de publication va déployer ces sites à la racine de la branche master du dépôt username.github.io. 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).
+
+
Vous devrez modifier le fichier website/siteConfig.js et ajouter les paramètres requis.
+
+
+
+
Nom
Description
+
+
+
organizationName
L'utilisateur ou l'organisation GitHub qui possède le dépôt. Si vous en êtes le propriétaire, c'est votre nom d'utilisateur GitHub. Dans le cas de Docusaurus, ce serait l'organisation GitHub "facebook".
+
projectName
Le nom du dépôt GitHub pour votre projet. 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".
+
url
L'URL de votre site web. Pour les projets hébergés sur des pages GitHub, ce sera "https://username.github.io"
+
baseUrl
L'URL de base pour votre projet. Pour les projets hébergés sur des pages GitHub, il suit le format "/projectName/". Pour https://github.com/facebook/docusaurus, baseUrl est /docusaurus/.
+
+
+
const siteConfig = {
+ ...
+ url: 'https://__userName__.github.io', // L'URL de votre site web
+ baseUrl: '/testProject/',
+ projectName: 'testProject',
+ organizationName: 'userName'
+ ...
+}
+
+
Dans le cas où vous souhaitez déployer le site en tant qu'utilisateur ou organisation, spécifiez le nom du projet comme <username>.github.io ou <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.
+
Remarque : Ne pas définir url et baseUrl de votre projet peuvent entraîner la création de chemins de fichiers incorrects qui peuvent casser des liens vers des chemins de ressources tels que les feuilles de style et les images.
+
+
Bien que nous recommandions de définir les projectName et organizationName dans siteConfig.js, vous pouvez également utiliser les variables d'environnement ORGANIZATION_NAME et PROJECT_NAME.
+
+
+
Maintenant vous devez spécifier l'utilisateur git comme variable d'environnement, et exécuter le script publish-gh-pages
+
+
+
+
Nom
Description
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your repositories, this will usually be your own GitHub username. Le GIT_USER spécifié doit avoir accès au dépôt spécifié dans la combinaison de organisationName et projectName.
+
+
+
Pour exécuter le script directement à partir de la ligne de commande, vous pouvez utiliser le suivant, en remplissant les valeurs de paramètre comme il se doit.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # ou `npm run publish-gh-pages`
+
Il y a également deux paramètres optionnels définis comme variables d'environnement :
+
+
+
Nom
Description
+
+
+
USE_SSH
Si cela est défini à true, alors SSH est utilisé au lieu de HTTPS pour la connexion au dépôt GitHub. HTTPS est la valeur par défaut si cette variable n'est pas définie.
+
CURRENT_BRANCH
La branche qui contient les dernières modifications docs qui seront déployées. Habituellement, la branche sera master, mais peut être n'importe quelle branche (par défaut ou autrement) sauf pour gh-pages. Si rien n'est défini pour cette variable, la branche actuelle sera utilisée.
+
+
+
Si vous rencontrez des problèmes liés aux clés SSH, visitez la documentation d'authentification GitHub.
+
Vous devriez maintenant pouvoir charger votre site en visitant son URL GitHub Pages, ce qui pourrait être quelque chose en suivant les lignes de https://username.github.io/projectName, ou un domaine personnalisé si vous avez configuré cette page. Par exemple, l'URL GitHub de Docusaurus est https://facebook.github.io/Docusaurus car elle est desservie par la branche gh-pages du dépôt GitHub https://github.com/facebook/docurus. Cependant, il est également accessible via https://docusaurus.io/, via un fichier CNAME généré qui peut être configuré via cname de l'option siteConfig.
+
Nous encourageons vivement la lecture à travers la documentation GitHub Pages pour en savoir plus sur le fonctionnement de cette solution d'hébergement.
+
Vous pouvez exécuter la commande au-dessus de chaque fois que vous mettez à jour les documents et que vous souhaitez déployer les modifications de votre site. L'exécution manuelle du script peut être excellente pour les sites où la documentation change rarement et il n'est pas trop gênant de se souvenir de déployer manuellement des modifications.
+
Cependant, vous pouvez automatiser le processus de publication avec une intégration continue (CI).
+
Automatisation des déploiements en utilisant une intégration continue
+
Les services d'intégration continue (CI) sont généralement utilisés pour effectuer des tâches de routine lorsque de nouveaux commits sont vérifiés pour contrôler la source. Ces tâches peuvent être une combinaison de tests unitaires et de tests d'intégration, d'automatisation des builds, de publication des paquets vers NPM, et oui, de déploiement de modifications sur votre site Web. All you need to do to automate the deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. Dans la section suivante, nous allons couvrir la façon de faire juste cela en utilisant CircleCI, un fournisseur de service d'intégration continue populaire.
+
Utilisation de CircleCI 2.0
+
Si vous ne l'avez pas déjà fait, vous pouvez configurer CircleCI pour votre projet open source. Ensuite, afin d'activer le déploiement automatique de votre site et de la documentation via CircleCI, il suffit de configurer Circle pour exécuter le script publish-gh-pages dans la partie de l'étape de déploiement. Vous pouvez suivre les étapes ci-dessous pour obtenir cette configuration.
+
+
Assurez-vous que le compte GitHub qui sera défini comme GIT_USER a l'accès d'écriture au dépôt qui contient la documentation, en vérifiant Paramètres | Collaborateurs & équipes dans le dépôt.
+
Connectez-vous à GitHub sous GIT_USER.
+
Allez sur https://github.com/settings/tokens pour le GIT_USER et générez un nouveau jeton d'accès personnel, lui accordant le contrôle total des dépôts privés via le champ d'application repository. Stockez ce jeton dans un endroit sûr, assurez-vous de ne pas le partager avec n'importe qui. Ce jeton peut être utilisé pour authentifier les actions GitHub en votre nom à la place de votre mot de passe GitHub.
+
Ouvrez votre tableau de bord CircleCI et naviguez sur la page Paramètres de votre dépôt, puis sélectionnez "variables d'environnement". L'URL ressemble à https://circleci.com/gh/ORG/REPO/edit#env-vars, où "ORG/REPO" devrait être remplacé par votre propre organisation/référentiel GitHub.
+
Créez une nouvelle variable d'environnement nommée GITHUB_TOKEN, en utilisant votre jeton d'accès nouvellement généré comme valeur.
+
Créez un répertoire .circleci et créez un fichier config.yml dans ce répertoire.
+
Copiez le texte ci-dessous dans .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
Assurez-vous de remplacer tous les <....> dans command: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour pousser dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.
+
NE PAS placer la valeur réelle de $GITHUB_TOKEN dans circle.yml. Nous avons déjà configuré cela en tant que variable d'environnement à l'étape 5.
+
+
Si vous voulez utiliser SSH pour votre connexion de dépôt GitHub, vous pouvez définir USE_SSH=true. La commande ci-dessus ressemblerait donc à : cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.
+
+
+
Contrairement au script publish-gh-pages lancé manuellement, lorsque le script s'exécute dans l'environnement Circle, la valeur de CURRENT_BRANCH est déjà définie comme une variable d'environnement dans CircleCI et sera récupérée automatiquement par le script.
+
+
Maintenant, chaque fois qu'un nouveau commit se trouve dans master, CircleCI exécutera votre suite de tests et, si tout passe, votre site sera déployé via le script publish-gh-pages .
+
+
Si vous préférez utiliser une clé de déploiement au lieu d'un jeton d'accès personnel, vous pouvez en commençant par les instructions de CircleCI pour ajouter une clé de déploiement en lecture/écriture.
+
+
Conseils & astuces
+
Lorsque vous déployez pour la première fois la branche gh-pages en utilisant CircleCI, vous pouvez remarquer que certains jobs déclenchés par des commits sur la branche gh-pages ne parviennent pas s'exécuter correctement à cause du manque de tests (cela peut également envoyer des notifications de builds échoués sur chat/slack).
+
Vous pouvez contourner cela :
+
+
Définition de la variable d'environnement CUSTOM_COMMIT_MESSAGE dans la commande publish-gh-pages avec le contenu de [skip ci]. Par exemple :
+
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+ yarn run publish-gh-pages # ou `npm run publish-gh-pages`
+
+
+
Vous pouvez également travailler autour de cela en créant une configuration CircleCI basique avec le contenu suivant :
+
+
# CircleCI 2.0 Fichier de configuration
+# Ce fichier de configuration empêchera l'exécution de tests sur la branche gh-pages.
+version:2
+jobs:
+ build:
+ machine:true
+ branches:
+ ignore:gh-pages
+ steps:
+ -run:echo"Ignore les tests sur la branche gh-pages"
+
+
Enregistrez ce fichier sous le nom config.yml et placez-le dans un répertoire .circleci dans votre répertoire website/static.
Ouvrez votre tableau de bord Travis CI. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
Créez une nouvelle variable d'environnement nommée GH_TOKEN avec votre jeton nouvellement généré, puis GH_EMAIL (votre adresse e-mail) et GH_NAME (votre nom d'utilisateur GitHub).
+
Créez un .travis.yml à la racine de votre dépôt avec le texte ci-dessous.
Maintenant, chaque fois qu'un nouveau commit se trouve dans master, Travis CI exécutera votre suite de tests et, si tout passe, votre site sera déployé via le script publish-gh-pages .
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Étapes pour configurer votre site alimenté par Docusaurus sur Netlify.
+
+
Sélectionnez Nouveau site depuis Git
+
Connectez-vous à votre fournisseur Git préféré.
+
Sélectionnez la branche à déployer. La valeur par défaut est master
+
Configurez vos étapes de construction :
+
+
Pour votre commande de build, saisissez : cd website; npm install; npm run build;
+
Pour publier le répertoire : website/build/<projectName> (utilisez le projectName de votre siteConfig)
+
+
Cliquez sur Déployer site
+
+
Vous pouvez également configurer Netlify pour qu'il reconstruise sur chaque commit de votre dépôt, ou seulement sur les commits de la branche master.
+
Hébergement sur Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Déployez votre application en quelques minutes en suivant ces étapes.
+
+
Créez un nouveau Service Web sur Render, et donnez la permission à l'application GitHub de Render d'accéder à votre dépôt Docusaurus.
+
Sélectionnez la branche à déployer. La valeur par défaut est master.
+
Entrez les valeurs suivantes pendant la création.
+
+
+
Champ
Valeur
+
+
+
Environment
Site statique
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName est la valeur que vous avez définie dans votre siteConfig.js.
C'est tout ! Votre application sera directement sur votre URL Render dès que la version sera terminée.
+
Publication sur GitHub Enterprise
+
Les installations de GitHub entreprise devraient fonctionner de la même manière que github.com; vous n'avez qu'à identifier l'hôte GitHub Enterprise de l'organisation.
+
+
+
Nom
Description
+
+
+
GITHUB_HOST
Le nom d'hôte du serveur d'entreprise GitHub.
+
+
+
Modifiez votre siteConfig.js pour ajouter une propriété 'githubHost' qui représente le nom d'hôte GitHub Entreprise. Autrement, définissez une variable d'environnement GITHUB_HOST lors de l'exécution de la commande publication.
\ No newline at end of file
diff --git a/docs/fr/publishing/index.html b/docs/fr/publishing/index.html
new file mode 100644
index 0000000000..511f160c4f
--- /dev/null
+++ b/docs/fr/publishing/index.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
Vous devez avoir maintenant un site fonctionnant localement. Une fois que vous l'avez personnalisé à votre gout, c'est le temps de le publier. Docusaurus génère un site web HTML statique qui est prêt à être servi par votre serveur web préféré ou une solution d'hébergement en ligne.
+
Création des pages HTML statiques
+
Pour créer une version statique de votre site web, exécutez le script suivant dans le dossier website:
+
yarn run build # ou `npm run build`
+
+
Cela va générer un dossier build dans le dossier website contenant les fichiers .html de toute votre documentation et d'autres pages incluses dans pages.
+
Hébergement de pages HTML statiques
+
À ce point, vous pouvez prendre tous les fichiers dans le dossier website/build et les copier dans votre dossier html de votre serveur web préféré.
+
+
Par exemple, Apache et Nginx diffuse le contenu à partir de /var/www/html par défaut. Cela dit, choisir un serveur web ou un hébergeur est à l'extérieur du cadre de Docusaurus.
+
+
+
Lorsque vous diffusez le site à partir de votre propre serveur web, assurez-vous que le serveur web fournit bien les fichiers de composants avec les entêtes HTTP appropriés. Les fichiers CSS doivent être servis avec l'entête content-type de text/css. Dans le cas de Nginx, cela signifierait le paramètre inclure /etc/nginx/mime.types; dans votre fichier nginx.conf . Consulter ce problème pour plus d'informations.
Exécutez une seule commande dans le répertoire racine de votre projet :
+
+
vercel
+
+
C'est tout. Vos docs seront automatiquement déployées.
+
+
Notez que la prise en charge de la structure de répertoire de Now est légèrement différente de la structure de répertoire par défaut d'un projet Docusaurus - Le répertoire docs doit être dans le répertoire website, suivant idéalement la structure des répertoires dans cet exemple. Vous devrez également spécifier une valeur customDocsPath dans siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Utilisation de Github Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
Même si votre dépôt est privé, tout ce qui est publié dans une branche gh-pages sera public.
+
+
Remarque : Lorsque vous déployez en tant qu'utilisateur/organisation des pages, le script de publication va déployer ces sites à la racine de la branche master du dépôt username.github.io. 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).
+
+
Vous devrez modifier le fichier website/siteConfig.js et ajouter les paramètres requis.
+
+
+
+
Nom
Description
+
+
+
organizationName
L'utilisateur ou l'organisation GitHub qui possède le dépôt. Si vous en êtes le propriétaire, c'est votre nom d'utilisateur GitHub. Dans le cas de Docusaurus, ce serait l'organisation GitHub "facebook".
+
projectName
Le nom du dépôt GitHub pour votre projet. 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".
+
url
L'URL de votre site web. Pour les projets hébergés sur des pages GitHub, ce sera "https://username.github.io"
+
baseUrl
L'URL de base pour votre projet. Pour les projets hébergés sur des pages GitHub, il suit le format "/projectName/". Pour https://github.com/facebook/docusaurus, baseUrl est /docusaurus/.
+
+
+
const siteConfig = {
+ ...
+ url: 'https://__userName__.github.io', // L'URL de votre site web
+ baseUrl: '/testProject/',
+ projectName: 'testProject',
+ organizationName: 'userName'
+ ...
+}
+
+
Dans le cas où vous souhaitez déployer le site en tant qu'utilisateur ou organisation, spécifiez le nom du projet comme <username>.github.io ou <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.
+
Remarque : Ne pas définir url et baseUrl de votre projet peuvent entraîner la création de chemins de fichiers incorrects qui peuvent casser des liens vers des chemins de ressources tels que les feuilles de style et les images.
+
+
Bien que nous recommandions de définir les projectName et organizationName dans siteConfig.js, vous pouvez également utiliser les variables d'environnement ORGANIZATION_NAME et PROJECT_NAME.
+
+
+
Maintenant vous devez spécifier l'utilisateur git comme variable d'environnement, et exécuter le script publish-gh-pages
+
+
+
+
Nom
Description
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your repositories, this will usually be your own GitHub username. Le GIT_USER spécifié doit avoir accès au dépôt spécifié dans la combinaison de organisationName et projectName.
+
+
+
Pour exécuter le script directement à partir de la ligne de commande, vous pouvez utiliser le suivant, en remplissant les valeurs de paramètre comme il se doit.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # ou `npm run publish-gh-pages`
+
Il y a également deux paramètres optionnels définis comme variables d'environnement :
+
+
+
Nom
Description
+
+
+
USE_SSH
Si cela est défini à true, alors SSH est utilisé au lieu de HTTPS pour la connexion au dépôt GitHub. HTTPS est la valeur par défaut si cette variable n'est pas définie.
+
CURRENT_BRANCH
La branche qui contient les dernières modifications docs qui seront déployées. Habituellement, la branche sera master, mais peut être n'importe quelle branche (par défaut ou autrement) sauf pour gh-pages. Si rien n'est défini pour cette variable, la branche actuelle sera utilisée.
+
+
+
Si vous rencontrez des problèmes liés aux clés SSH, visitez la documentation d'authentification GitHub.
+
Vous devriez maintenant pouvoir charger votre site en visitant son URL GitHub Pages, ce qui pourrait être quelque chose en suivant les lignes de https://username.github.io/projectName, ou un domaine personnalisé si vous avez configuré cette page. Par exemple, l'URL GitHub de Docusaurus est https://facebook.github.io/Docusaurus car elle est desservie par la branche gh-pages du dépôt GitHub https://github.com/facebook/docurus. Cependant, il est également accessible via https://docusaurus.io/, via un fichier CNAME généré qui peut être configuré via cname de l'option siteConfig.
+
Nous encourageons vivement la lecture à travers la documentation GitHub Pages pour en savoir plus sur le fonctionnement de cette solution d'hébergement.
+
Vous pouvez exécuter la commande au-dessus de chaque fois que vous mettez à jour les documents et que vous souhaitez déployer les modifications de votre site. L'exécution manuelle du script peut être excellente pour les sites où la documentation change rarement et il n'est pas trop gênant de se souvenir de déployer manuellement des modifications.
+
Cependant, vous pouvez automatiser le processus de publication avec une intégration continue (CI).
+
Automatisation des déploiements en utilisant une intégration continue
+
Les services d'intégration continue (CI) sont généralement utilisés pour effectuer des tâches de routine lorsque de nouveaux commits sont vérifiés pour contrôler la source. Ces tâches peuvent être une combinaison de tests unitaires et de tests d'intégration, d'automatisation des builds, de publication des paquets vers NPM, et oui, de déploiement de modifications sur votre site Web. All you need to do to automate the deployment of your website is to invoke the publish-gh-pages script whenever your docs get updated. Dans la section suivante, nous allons couvrir la façon de faire juste cela en utilisant CircleCI, un fournisseur de service d'intégration continue populaire.
+
Utilisation de CircleCI 2.0
+
Si vous ne l'avez pas déjà fait, vous pouvez configurer CircleCI pour votre projet open source. Ensuite, afin d'activer le déploiement automatique de votre site et de la documentation via CircleCI, il suffit de configurer Circle pour exécuter le script publish-gh-pages dans la partie de l'étape de déploiement. Vous pouvez suivre les étapes ci-dessous pour obtenir cette configuration.
+
+
Assurez-vous que le compte GitHub qui sera défini comme GIT_USER a l'accès d'écriture au dépôt qui contient la documentation, en vérifiant Paramètres | Collaborateurs & équipes dans le dépôt.
+
Connectez-vous à GitHub sous GIT_USER.
+
Allez sur https://github.com/settings/tokens pour le GIT_USER et générez un nouveau jeton d'accès personnel, lui accordant le contrôle total des dépôts privés via le champ d'application repository. Stockez ce jeton dans un endroit sûr, assurez-vous de ne pas le partager avec n'importe qui. Ce jeton peut être utilisé pour authentifier les actions GitHub en votre nom à la place de votre mot de passe GitHub.
+
Ouvrez votre tableau de bord CircleCI et naviguez sur la page Paramètres de votre dépôt, puis sélectionnez "variables d'environnement". L'URL ressemble à https://circleci.com/gh/ORG/REPO/edit#env-vars, où "ORG/REPO" devrait être remplacé par votre propre organisation/référentiel GitHub.
+
Créez une nouvelle variable d'environnement nommée GITHUB_TOKEN, en utilisant votre jeton d'accès nouvellement généré comme valeur.
+
Créez un répertoire .circleci et créez un fichier config.yml dans ce répertoire.
+
Copiez le texte ci-dessous dans .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
Assurez-vous de remplacer tous les <....> dans command: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour pousser dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.
+
NE PAS placer la valeur réelle de $GITHUB_TOKEN dans circle.yml. Nous avons déjà configuré cela en tant que variable d'environnement à l'étape 5.
+
+
Si vous voulez utiliser SSH pour votre connexion de dépôt GitHub, vous pouvez définir USE_SSH=true. La commande ci-dessus ressemblerait donc à : cd website && npm install && GIT_USER=<GIT_USER> USE_SSH=true npm run publish-gh-pages.
+
+
+
Contrairement au script publish-gh-pages lancé manuellement, lorsque le script s'exécute dans l'environnement Circle, la valeur de CURRENT_BRANCH est déjà définie comme une variable d'environnement dans CircleCI et sera récupérée automatiquement par le script.
+
+
Maintenant, chaque fois qu'un nouveau commit se trouve dans master, CircleCI exécutera votre suite de tests et, si tout passe, votre site sera déployé via le script publish-gh-pages .
+
+
Si vous préférez utiliser une clé de déploiement au lieu d'un jeton d'accès personnel, vous pouvez en commençant par les instructions de CircleCI pour ajouter une clé de déploiement en lecture/écriture.
+
+
Conseils & astuces
+
Lorsque vous déployez pour la première fois la branche gh-pages en utilisant CircleCI, vous pouvez remarquer que certains jobs déclenchés par des commits sur la branche gh-pages ne parviennent pas s'exécuter correctement à cause du manque de tests (cela peut également envoyer des notifications de builds échoués sur chat/slack).
+
Vous pouvez contourner cela :
+
+
Définition de la variable d'environnement CUSTOM_COMMIT_MESSAGE dans la commande publish-gh-pages avec le contenu de [skip ci]. Par exemple :
+
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+ yarn run publish-gh-pages # ou `npm run publish-gh-pages`
+
+
+
Vous pouvez également travailler autour de cela en créant une configuration CircleCI basique avec le contenu suivant :
+
+
# CircleCI 2.0 Fichier de configuration
+# Ce fichier de configuration empêchera l'exécution de tests sur la branche gh-pages.
+version:2
+jobs:
+ build:
+ machine:true
+ branches:
+ ignore:gh-pages
+ steps:
+ -run:echo"Ignore les tests sur la branche gh-pages"
+
+
Enregistrez ce fichier sous le nom config.yml et placez-le dans un répertoire .circleci dans votre répertoire website/static.
Ouvrez votre tableau de bord Travis CI. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
Créez une nouvelle variable d'environnement nommée GH_TOKEN avec votre jeton nouvellement généré, puis GH_EMAIL (votre adresse e-mail) et GH_NAME (votre nom d'utilisateur GitHub).
+
Créez un .travis.yml à la racine de votre dépôt avec le texte ci-dessous.
Maintenant, chaque fois qu'un nouveau commit se trouve dans master, Travis CI exécutera votre suite de tests et, si tout passe, votre site sera déployé via le script publish-gh-pages .
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Étapes pour configurer votre site alimenté par Docusaurus sur Netlify.
+
+
Sélectionnez Nouveau site depuis Git
+
Connectez-vous à votre fournisseur Git préféré.
+
Sélectionnez la branche à déployer. La valeur par défaut est master
+
Configurez vos étapes de construction :
+
+
Pour votre commande de build, saisissez : cd website; npm install; npm run build;
+
Pour publier le répertoire : website/build/<projectName> (utilisez le projectName de votre siteConfig)
+
+
Cliquez sur Déployer site
+
+
Vous pouvez également configurer Netlify pour qu'il reconstruise sur chaque commit de votre dépôt, ou seulement sur les commits de la branche master.
+
Hébergement sur Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Déployez votre application en quelques minutes en suivant ces étapes.
+
+
Créez un nouveau Service Web sur Render, et donnez la permission à l'application GitHub de Render d'accéder à votre dépôt Docusaurus.
+
Sélectionnez la branche à déployer. La valeur par défaut est master.
+
Entrez les valeurs suivantes pendant la création.
+
+
+
Champ
Valeur
+
+
+
Environment
Site statique
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName est la valeur que vous avez définie dans votre siteConfig.js.
C'est tout ! Votre application sera directement sur votre URL Render dès que la version sera terminée.
+
Publication sur GitHub Enterprise
+
Les installations de GitHub entreprise devraient fonctionner de la même manière que github.com; vous n'avez qu'à identifier l'hôte GitHub Enterprise de l'organisation.
+
+
+
Nom
Description
+
+
+
GITHUB_HOST
Le nom d'hôte du serveur d'entreprise GitHub.
+
+
+
Modifiez votre siteConfig.js pour ajouter une propriété 'githubHost' qui représente le nom d'hôte GitHub Entreprise. Autrement, définissez une variable d'environnement GITHUB_HOST lors de l'exécution de la commande publication.
\ No newline at end of file
diff --git a/docs/fr/search.html b/docs/fr/search.html
new file mode 100644
index 0000000000..36c55662e3
--- /dev/null
+++ b/docs/fr/search.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
Docusaurus prend en charge la recherche en utilisant Algolia DocSearch. Une fois que votre site est en ligne, vous pouvez le soumettre à DocSearch. Algolia vous enverra alors les identifiants que vous pourrez ajouter à votre siteConfig.js.
+
DocSearch travaille en explorant le contenu de votre site Web toutes les 24 heures et en mettant tout le contenu dans un index Algolia. Ce contenu est ensuite interrogé directement depuis votre front-end en utilisant l'API Algolia. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). Ce service est gratuit.
+
Activation de la barre de recherche
+
Entrez votre clé API et le nom de l'index (envoyé par Algolia) dans siteConfig.js dans la section algolia pour activer la recherche de votre site.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Options de recherche supplémentaires
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Cela peut être utile si vous voulez fournir des résultats de recherche différents pour les différentes versions ou langues de vos docs. Toutes les occurrences de "VERSION" ou "LANGUAGE" seront remplacées respectivement par la version ou la langue de la page courante. Plus de détails sur les options de recherche peuvent être trouvés ici.
Algolia might provide you with extra search options. Si c'est le cas, vous devriez les ajouter à l'objet algoliaOptions.
+
Contrôle de l'emplacement de la barre de recherche
+
Par défaut, la barre de recherche sera l'élément le plus à droite de la barre de navigation supérieure.
+
Si vous voulez changer l'emplacement par défaut, ajoutez l'option searchBar dans le champ headerLinks de siteConfig.js à l'emplacement souhaité. Par exemple, vous souhaitez peut-être que la barre de recherche se trouve entre vos liens internes et externes.
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:
\ No newline at end of file
diff --git a/docs/fr/search/index.html b/docs/fr/search/index.html
new file mode 100644
index 0000000000..36c55662e3
--- /dev/null
+++ b/docs/fr/search/index.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
Docusaurus prend en charge la recherche en utilisant Algolia DocSearch. Une fois que votre site est en ligne, vous pouvez le soumettre à DocSearch. Algolia vous enverra alors les identifiants que vous pourrez ajouter à votre siteConfig.js.
+
DocSearch travaille en explorant le contenu de votre site Web toutes les 24 heures et en mettant tout le contenu dans un index Algolia. Ce contenu est ensuite interrogé directement depuis votre front-end en utilisant l'API Algolia. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). Ce service est gratuit.
+
Activation de la barre de recherche
+
Entrez votre clé API et le nom de l'index (envoyé par Algolia) dans siteConfig.js dans la section algolia pour activer la recherche de votre site.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Options de recherche supplémentaires
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Cela peut être utile si vous voulez fournir des résultats de recherche différents pour les différentes versions ou langues de vos docs. Toutes les occurrences de "VERSION" ou "LANGUAGE" seront remplacées respectivement par la version ou la langue de la page courante. Plus de détails sur les options de recherche peuvent être trouvés ici.
Algolia might provide you with extra search options. Si c'est le cas, vous devriez les ajouter à l'objet algoliaOptions.
+
Contrôle de l'emplacement de la barre de recherche
+
Par défaut, la barre de recherche sera l'élément le plus à droite de la barre de navigation supérieure.
+
Si vous voulez changer l'emplacement par défaut, ajoutez l'option searchBar dans le champ headerLinks de siteConfig.js à l'emplacement souhaité. Par exemple, vous souhaitez peut-être que la barre de recherche se trouve entre vos liens internes et externes.
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:
\ No newline at end of file
diff --git a/docs/fr/site-config.html b/docs/fr/site-config.html
new file mode 100644
index 0000000000..5fb9aeadb7
--- /dev/null
+++ b/docs/fr/site-config.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
Une grande partie de la configuration du site est effectuée en éditant le fichier siteConfig.js.
+
User Showcase
+
Le tableau users est utilisé pour stocker des objets pour chaque projet/utilisateur que vous voulez afficher sur votre site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Chaque objet utilisateur doit avoir les champs caption, image, infoLink et pinned. Le champ caption est le texte affiché lorsque quelqu'un survole l'image de cet utilisateur, le champ infoLink est le lien qui redirige vers un utilisateur. Le champ pinned détermine s'il apparaît sur la page index.
+
Actuellement, ce tableau users n’est utilisé que par les fichiers d’exemple index.js et users.js. Si vous ne souhaitez pas avoir de page d’utilisateurs ou afficher les utilisateurs sur la page d’index, vous pouvez supprimer cette section.
+
L'objet siteConfig
+
L’objet siteConfig contient l’essentiel des paramètres de configuration de votre site Web.
+
Champs obligatoires
+
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/. Pour les URL qui n’ont pas de chemin d’accès, le baseUrl doit être défini sur /. This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor est la couleur utilisée dans la barre de navigation du header et les sidebars.
+
secondaryColor est la couleur visible dans la deuxième ligne de la barre de navigation du header lorsque la fenêtre du site est réduites (mobile inclus).
+
Des configurations de couleurs personnalisées peuvent également être ajoutées. Par exemple, si des styles utilisateur sont ajoutés avec des couleurs spécifiées comme $myColor, l’ajout d’un champ myColor à colors vous permettra de configurer cette couleur.
+
+
copyright [string]
+
Le texte de copyright en bas de page et dans le flux
+
favicon [string]
+
URL du favicon du site.
+
headerIcon [string]
+
URL de l'icône utilisée dans la barre de navigation.
+
headerLinks [array]
+
Links that will be used in the header navigation bar. Le champ label de chaque objet sera le texte du lien et sera également traduit pour chaque langue.
+
Exemple d'utilisation :
+
headerLinks: [
+ // Liens vers le document avec l'Id doc1 pour la langue / version actuelle
+ { doc: "doc1", label: "Getting Started" },
+ // Lien vers la page trouvée à pages /en/help.js ou si cela n'existe pas, pages /help.js, pour la langue courante
+ { page: "help", label: "Help" },
+ // Liens vers la destination href, en utilisant target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // Liens vers le blog généré par Docusaurus (${baseUrl}blog)
+ { blog: true, label: "Blog" },
+ // Détermine la position de la barre de recherche parmi les liens
+ { search: true },
+ // Détermine la position de la liste déroulante de la langue parmi les liens
+ { 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. Pour exemple, https://facebook.github.io est l'URL de https://facebook.github.io/metro/, et https://docusaurus.io est l'URL pour https://docusaurus.io. This field is related to the baseUrl field.
+
Champs optionnels
+
algolia [object]
+
Information for Algolia search integration. Si ce champ est exclu, la barre de recherche n'apparaîtra pas dans l'en-tête. Vous devez spécifier deux valeurs pour ce champ, et une (appId) est optionnelle.
+
+
apiKey - la clé API fournie par Algolia pour votre recherche.
+
indexName - le nom d'index fourni par Algolia pour votre recherche (en général, c'est le nom du projet)
+
appId - Algolia fournit un scraper par défaut pour vos docs. Si vous fournissez vous-même, vous obtiendrez probablement cet identifiant.
+
+
blogSidebarCount [number]
+
Control the number of blog posts that show up in the sidebar. Voir ajouter un docs de blog pour plus d'informations.
+
blogSidebarTitle [string]
+
Control the title of the blog sidebar. Voir ajouter un docs de blog pour plus d'informations.
Si les utilisateurs ont l'intention d'utiliser ce site exclusivement hors ligne, cette valeur doit être définie à false. Sinon, le site sera dirigé vers le dossier parent de la page liée.
+
+
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.
+
deletedDocs [object]
+
Même si vous supprimez le fichier principal d'une page de documentation et que vous le supprimez de votre barre latérale, la page sera toujours créée pour chaque version et pour la version courante en raison de la fallback functionality. Cela peut conduire à la confusion si les gens trouvent la documentation en cherchant et il semble que ce soit quelque chose de pertinent pour une version particulière, mais ce n'est pas le cas.
+
Pour forcer la suppression du contenu commençant par une certaine version (y compris pour current/next), ajoutez un objet deletedDocs à votre config, où chaque clé est une version et la valeur est un tableau d'identifiants de document qui ne devraient pas être générés pour cette version et toutes les versions ultérieures.
Les clés de version doivent correspondre à celles de versions.json. En supposant que la liste des versions dans versions.json est ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], les docs/1.0.0/tagging et docs/1.0/tagging les URLs fonctionneront mais docs/2.0.0/tagging, docs/3.0.0/tagging, et docs/tagging ne fonctionneront pas. Les fichiers et dossiers de ces versions ne seront pas générés pendant la compilation.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Définit la fonction de préprocess de slug si vous voulez personnaliser le texte utilisé pour générer les liens de hachage. La fonction fournit le texte de base comme premier argument et doit toujours renvoyer un texte.
+
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.
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.
+
Ajouter des Google Fonts
+
+
Google Fonts offre des temps de chargement de polices plus rapides en utilisant un système de cache anonyme. Pour plus d'informations, se référer à la documentation Google Fonts.
+
Pour ajouter Google Fonts à votre déploiement Docusaurus, ajoutez la police dans le fichier siteConfig.js sous stylesheets:
\ No newline at end of file
diff --git a/docs/fr/site-config/index.html b/docs/fr/site-config/index.html
new file mode 100644
index 0000000000..5fb9aeadb7
--- /dev/null
+++ b/docs/fr/site-config/index.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
Une grande partie de la configuration du site est effectuée en éditant le fichier siteConfig.js.
+
User Showcase
+
Le tableau users est utilisé pour stocker des objets pour chaque projet/utilisateur que vous voulez afficher sur votre site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Chaque objet utilisateur doit avoir les champs caption, image, infoLink et pinned. Le champ caption est le texte affiché lorsque quelqu'un survole l'image de cet utilisateur, le champ infoLink est le lien qui redirige vers un utilisateur. Le champ pinned détermine s'il apparaît sur la page index.
+
Actuellement, ce tableau users n’est utilisé que par les fichiers d’exemple index.js et users.js. Si vous ne souhaitez pas avoir de page d’utilisateurs ou afficher les utilisateurs sur la page d’index, vous pouvez supprimer cette section.
+
L'objet siteConfig
+
L’objet siteConfig contient l’essentiel des paramètres de configuration de votre site Web.
+
Champs obligatoires
+
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/. Pour les URL qui n’ont pas de chemin d’accès, le baseUrl doit être défini sur /. This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor est la couleur utilisée dans la barre de navigation du header et les sidebars.
+
secondaryColor est la couleur visible dans la deuxième ligne de la barre de navigation du header lorsque la fenêtre du site est réduites (mobile inclus).
+
Des configurations de couleurs personnalisées peuvent également être ajoutées. Par exemple, si des styles utilisateur sont ajoutés avec des couleurs spécifiées comme $myColor, l’ajout d’un champ myColor à colors vous permettra de configurer cette couleur.
+
+
copyright [string]
+
Le texte de copyright en bas de page et dans le flux
+
favicon [string]
+
URL du favicon du site.
+
headerIcon [string]
+
URL de l'icône utilisée dans la barre de navigation.
+
headerLinks [array]
+
Links that will be used in the header navigation bar. Le champ label de chaque objet sera le texte du lien et sera également traduit pour chaque langue.
+
Exemple d'utilisation :
+
headerLinks: [
+ // Liens vers le document avec l'Id doc1 pour la langue / version actuelle
+ { doc: "doc1", label: "Getting Started" },
+ // Lien vers la page trouvée à pages /en/help.js ou si cela n'existe pas, pages /help.js, pour la langue courante
+ { page: "help", label: "Help" },
+ // Liens vers la destination href, en utilisant target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // Liens vers le blog généré par Docusaurus (${baseUrl}blog)
+ { blog: true, label: "Blog" },
+ // Détermine la position de la barre de recherche parmi les liens
+ { search: true },
+ // Détermine la position de la liste déroulante de la langue parmi les liens
+ { 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. Pour exemple, https://facebook.github.io est l'URL de https://facebook.github.io/metro/, et https://docusaurus.io est l'URL pour https://docusaurus.io. This field is related to the baseUrl field.
+
Champs optionnels
+
algolia [object]
+
Information for Algolia search integration. Si ce champ est exclu, la barre de recherche n'apparaîtra pas dans l'en-tête. Vous devez spécifier deux valeurs pour ce champ, et une (appId) est optionnelle.
+
+
apiKey - la clé API fournie par Algolia pour votre recherche.
+
indexName - le nom d'index fourni par Algolia pour votre recherche (en général, c'est le nom du projet)
+
appId - Algolia fournit un scraper par défaut pour vos docs. Si vous fournissez vous-même, vous obtiendrez probablement cet identifiant.
+
+
blogSidebarCount [number]
+
Control the number of blog posts that show up in the sidebar. Voir ajouter un docs de blog pour plus d'informations.
+
blogSidebarTitle [string]
+
Control the title of the blog sidebar. Voir ajouter un docs de blog pour plus d'informations.
Si les utilisateurs ont l'intention d'utiliser ce site exclusivement hors ligne, cette valeur doit être définie à false. Sinon, le site sera dirigé vers le dossier parent de la page liée.
+
+
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.
+
deletedDocs [object]
+
Même si vous supprimez le fichier principal d'une page de documentation et que vous le supprimez de votre barre latérale, la page sera toujours créée pour chaque version et pour la version courante en raison de la fallback functionality. Cela peut conduire à la confusion si les gens trouvent la documentation en cherchant et il semble que ce soit quelque chose de pertinent pour une version particulière, mais ce n'est pas le cas.
+
Pour forcer la suppression du contenu commençant par une certaine version (y compris pour current/next), ajoutez un objet deletedDocs à votre config, où chaque clé est une version et la valeur est un tableau d'identifiants de document qui ne devraient pas être générés pour cette version et toutes les versions ultérieures.
Les clés de version doivent correspondre à celles de versions.json. En supposant que la liste des versions dans versions.json est ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], les docs/1.0.0/tagging et docs/1.0/tagging les URLs fonctionneront mais docs/2.0.0/tagging, docs/3.0.0/tagging, et docs/tagging ne fonctionneront pas. Les fichiers et dossiers de ces versions ne seront pas générés pendant la compilation.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Définit la fonction de préprocess de slug si vous voulez personnaliser le texte utilisé pour générer les liens de hachage. La fonction fournit le texte de base comme premier argument et doit toujours renvoyer un texte.
+
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.
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.
+
Ajouter des Google Fonts
+
+
Google Fonts offre des temps de chargement de polices plus rapides en utilisant un système de cache anonyme. Pour plus d'informations, se référer à la documentation Google Fonts.
+
Pour ajouter Google Fonts à votre déploiement Docusaurus, ajoutez la police dans le fichier siteConfig.js sous stylesheets:
\ No newline at end of file
diff --git a/docs/fr/tutorial-create-pages.html b/docs/fr/tutorial-create-pages.html
new file mode 100644
index 0000000000..ed3478c55c
--- /dev/null
+++ b/docs/fr/tutorial-create-pages.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
Changez le texte dans le <p>...</p> en "Je peux écrire du JSX ici !" et enregistrer le fichier à nouveau. Le navigateur devrait se rafraîchir automatiquement pour faire apparaître le changement.
+
+
- <p>C'est ma première page !</p>
++ <p>Je peux écrire du JSX ici !</p>
+
+
React est utilisé comme moteur de template pour le rendu du balisage statique. Vous pouvez tirer parti de la puissance d'expression de React pour créer du contenu web riche. Apprenez en plus sur la création de pages ici.
+
+
Création d'une page de documentation
+
+
Créer un nouveau fichier dans le dossier docs appelé doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Collez le contenu suivant :
+
+
---
+id: doc9
+title: Il s'agit du Doc 9
+---
+
+Je peux écrire du contenu en utilisant la [syntaxe de Markdown flavored GitHub](https://github.github.com/gfm/).
+
+## Syntaxe de Markdown
+
+**Gras**_italique_`code` [Liens](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Salut
+* Ho
+* Allons-y
+
+
+
Le sidebars.json est l'endroit où vous spécifiez l'ordre de vos pages de documentation, alors ouvrez website/sidebars.json et ajoutez "doc9" après "doc1". Cet ID doit être le même que dans les métadonnées du fichier Markdown ci-dessus, donc si vous avez donné un ID différent à l'étape 2, assurez-vous d'utiliser le même ID dans le fichier de la barre latérale.
Un redémarrage du serveur est nécessaire pour récupérer les modifications de la barre latérale, alors allez dans votre terminal, tuer votre serveur de développement (Cmd + C ou Ctrl + C), et exécuter npm start ou yarn start.
\ No newline at end of file
diff --git a/docs/fr/tutorial-create-pages/index.html b/docs/fr/tutorial-create-pages/index.html
new file mode 100644
index 0000000000..ed3478c55c
--- /dev/null
+++ b/docs/fr/tutorial-create-pages/index.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
Changez le texte dans le <p>...</p> en "Je peux écrire du JSX ici !" et enregistrer le fichier à nouveau. Le navigateur devrait se rafraîchir automatiquement pour faire apparaître le changement.
+
+
- <p>C'est ma première page !</p>
++ <p>Je peux écrire du JSX ici !</p>
+
+
React est utilisé comme moteur de template pour le rendu du balisage statique. Vous pouvez tirer parti de la puissance d'expression de React pour créer du contenu web riche. Apprenez en plus sur la création de pages ici.
+
+
Création d'une page de documentation
+
+
Créer un nouveau fichier dans le dossier docs appelé doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Collez le contenu suivant :
+
+
---
+id: doc9
+title: Il s'agit du Doc 9
+---
+
+Je peux écrire du contenu en utilisant la [syntaxe de Markdown flavored GitHub](https://github.github.com/gfm/).
+
+## Syntaxe de Markdown
+
+**Gras**_italique_`code` [Liens](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Salut
+* Ho
+* Allons-y
+
+
+
Le sidebars.json est l'endroit où vous spécifiez l'ordre de vos pages de documentation, alors ouvrez website/sidebars.json et ajoutez "doc9" après "doc1". Cet ID doit être le même que dans les métadonnées du fichier Markdown ci-dessus, donc si vous avez donné un ID différent à l'étape 2, assurez-vous d'utiliser le même ID dans le fichier de la barre latérale.
Un redémarrage du serveur est nécessaire pour récupérer les modifications de la barre latérale, alors allez dans votre terminal, tuer votre serveur de développement (Cmd + C ou Ctrl + C), et exécuter npm start ou yarn start.
\ No newline at end of file
diff --git a/docs/fr/tutorial-version.html b/docs/fr/tutorial-version.html
new file mode 100644
index 0000000000..e24f83db9e
--- /dev/null
+++ b/docs/fr/tutorial-version.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
Avec un site d'exemple déployé, nous pouvons maintenant essayer l'une des fonctionnalités mortelles de Docusaurus — la documentation versionnée. La documentation versionnée aide à afficher la documentation pertinente pour la version actuelle d'un outil et à masquer la documentation non publiée aux utilisateurs, ce qui réduit la confusion. La documentation pour les anciennes versions est également conservée et accessible aux utilisateurs des anciennes versions d'un outil, même lorsque la dernière documentation est modifiée.
+
+
Libérer une version
+
Supposons que vous soyez satisfait de l'état actuel de la documentation et que vous vouliez la geler comme la documentation v1.0.0. Tout d'abord, vous cd dans le répertoire website et exécutez la commande suivante.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Ensuite, vous exécutez une commande avec la version que vous voulez créer, comme 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Testons comment le versionnage fonctionne réellement. Ouvrez docs/doc1.md et changez la première ligne du corps :
+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Page d'exemple
+---
+
+- Vérifiez la [documentation](https://docusaurus.io) pour savoir comment utiliser Docusaurus.
++ Ceci est la dernière version de la documentation.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+
Si vous allez sur http://localhost:3000/docusaurus-tutorial/docs/doc1 dans votre navigateur, vous vous rendez compte qu'il affiche toujours la ligne avant le changement. C'est parce que la version que vous regardez est la version 1.0.0, qui a déjà été figée dans le temps. Le document que vous avez modifié fait partie de la prochaine version.
+
Prochaine version
+
La dernière version des documents est consultable en ajoutant next à l'URL : http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Cliquez sur la version pour ouvrir la page des versions, qui a été créée à l'adresse http://localhost:3000/docusaurus-tutorial/versions avec une liste des versions de la documentation. Vous voyez que 1.0.0 et master y sont listées et qu'elles sont liées aux versions respectives de la documentation.
+
Les documents de master du répertoire docs sont devenus la version next lorsque le répertoire website/versioned_docs/version-1.0.0 a été créé pour la version 1.0.0.
+
Versions antérieures
+
Supposons que la documentation ait été modifiée et qu'elle ait besoin d'une mise à jour. Vous pouvez publier une autre version, comme la 1.0.1.
+
npm run version 1.0.1
+
+
La version 1.0.0 reste disponible en version antérieure. Vous pouvez le voir en ajoutant 1.0.0 à l'URL, http://localhost:3000/docusaurus-tutorial/docs/1.0.0/doc1. Un lien vers la version 1.0.0 apparaît également sur la page des versions.
+
Allez-y et publiez votre site versionné avec le script publish-gh-pages !
+
Récapitulatif
+
C'est fini, Mesdames Messieurs ! Dans ce court tutoriel, vous avez pu constater à quel point il est facile de créer un site Web de documentation à partir de zéro et de créer des versions. Il y a bien d'autres choses que vous pouvez faire avec Docusaurus, comme ajouter un blog, rechercher et traduire. Consultez la section Guide pour en savoir plus.
\ No newline at end of file
diff --git a/docs/fr/tutorial-version/index.html b/docs/fr/tutorial-version/index.html
new file mode 100644
index 0000000000..e24f83db9e
--- /dev/null
+++ b/docs/fr/tutorial-version/index.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
Avec un site d'exemple déployé, nous pouvons maintenant essayer l'une des fonctionnalités mortelles de Docusaurus — la documentation versionnée. La documentation versionnée aide à afficher la documentation pertinente pour la version actuelle d'un outil et à masquer la documentation non publiée aux utilisateurs, ce qui réduit la confusion. La documentation pour les anciennes versions est également conservée et accessible aux utilisateurs des anciennes versions d'un outil, même lorsque la dernière documentation est modifiée.
+
+
Libérer une version
+
Supposons que vous soyez satisfait de l'état actuel de la documentation et que vous vouliez la geler comme la documentation v1.0.0. Tout d'abord, vous cd dans le répertoire website et exécutez la commande suivante.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Ensuite, vous exécutez une commande avec la version que vous voulez créer, comme 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Testons comment le versionnage fonctionne réellement. Ouvrez docs/doc1.md et changez la première ligne du corps :
+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Page d'exemple
+---
+
+- Vérifiez la [documentation](https://docusaurus.io) pour savoir comment utiliser Docusaurus.
++ Ceci est la dernière version de la documentation.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+
Si vous allez sur http://localhost:3000/docusaurus-tutorial/docs/doc1 dans votre navigateur, vous vous rendez compte qu'il affiche toujours la ligne avant le changement. C'est parce que la version que vous regardez est la version 1.0.0, qui a déjà été figée dans le temps. Le document que vous avez modifié fait partie de la prochaine version.
+
Prochaine version
+
La dernière version des documents est consultable en ajoutant next à l'URL : http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Cliquez sur la version pour ouvrir la page des versions, qui a été créée à l'adresse http://localhost:3000/docusaurus-tutorial/versions avec une liste des versions de la documentation. Vous voyez que 1.0.0 et master y sont listées et qu'elles sont liées aux versions respectives de la documentation.
+
Les documents de master du répertoire docs sont devenus la version next lorsque le répertoire website/versioned_docs/version-1.0.0 a été créé pour la version 1.0.0.
+
Versions antérieures
+
Supposons que la documentation ait été modifiée et qu'elle ait besoin d'une mise à jour. Vous pouvez publier une autre version, comme la 1.0.1.
+
npm run version 1.0.1
+
+
La version 1.0.0 reste disponible en version antérieure. Vous pouvez le voir en ajoutant 1.0.0 à l'URL, http://localhost:3000/docusaurus-tutorial/docs/1.0.0/doc1. Un lien vers la version 1.0.0 apparaît également sur la page des versions.
+
Allez-y et publiez votre site versionné avec le script publish-gh-pages !
+
Récapitulatif
+
C'est fini, Mesdames Messieurs ! Dans ce court tutoriel, vous avez pu constater à quel point il est facile de créer un site Web de documentation à partir de zéro et de créer des versions. Il y a bien d'autres choses que vous pouvez faire avec Docusaurus, comme ajouter un blog, rechercher et traduire. Consultez la section Guide pour en savoir plus.
\ No newline at end of file
diff --git a/docs/ko/adding-blog.html b/docs/ko/adding-blog.html
new file mode 100644
index 0000000000..7a2beed093
--- /dev/null
+++ b/docs/ko/adding-blog.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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. 포스트의 날짜는 파일명에 지정된 날짜로 처리합니다.
+
For example, at website/blog/2017-12-14-introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
헤더 옵션
+
The only required field is title; however, we provide options to add author information to your blog post as well along with other options.
+
+
author - 작성자의 이름을 설정합니다.
+
authorURL - 작성자와 관련된 URL을 설정합니다. 트위터나 깃허브, 페이스북 주소 등이 될 수 있습니다.
+
authorFBID - 프로필 사진으로 사용할 페이스북 프로필 아이디를 설정합니다.
+
authorImageURL - 작성자 프로필 사진 이미지 URL을 설정합니다. (참고: authorFBID와 authorImageURL를 둘 다 설정한 경우에는 authorFBID 설정이 먼저 적용됩니다. authorImageURL 설정이 적용되기 원한다면 authorFBID 설정은 하지 말아야 합니다.)
+
title - 블로그 포스트 제목을 설정합니다.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
요약 보기
+
블로그 포스트에서 <!--truncate--> 마커를 사용하면 공개된 블로그 포스트의 요약 보기를 제공할 수 있습니다. <!--truncate--> 위에 작성한 내용이 요약 보기로 보여집니다. 예를 들면 아래와 같습니다.
Docusaurus provides an 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 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 twittersite configuration options in siteConfig.js.
+
Advanced Topics
+
블로그 전용으로 사용할 경우
+
You can run your Docusaurus site without a landing page and instead have your blog load first.
+
To do this:
+
+
website/static/ 디렉토리에 index.html 파일을 생성합니다.
+
website/static/index.html 파일에 템플릿으로 제공되는 콘텐츠를 추가합니다.
+
website/static/index.html 파일에서 <title> 태그 내용을 수정합니다.
+
동적인 랜딩 페이지로 만든 website/pages/en/index.js 파일을 삭제합니다.
+
+
+
이제 도큐사우르스를 빌드하게 되면 static/index.html 파일을 복사해서 사이트의 메인 디렉토리에 가져다놓게 됩니다. 방문자가 여러분의 페이지를 찾아오게 되면 정적인 파일을 제공하게 됩니다. When the page loads, it will redirect the visitor to /blog.
+
+
You can use this template:
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/ko/adding-blog/index.html b/docs/ko/adding-blog/index.html
new file mode 100644
index 0000000000..7a2beed093
--- /dev/null
+++ b/docs/ko/adding-blog/index.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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. 포스트의 날짜는 파일명에 지정된 날짜로 처리합니다.
+
For example, at website/blog/2017-12-14-introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
헤더 옵션
+
The only required field is title; however, we provide options to add author information to your blog post as well along with other options.
+
+
author - 작성자의 이름을 설정합니다.
+
authorURL - 작성자와 관련된 URL을 설정합니다. 트위터나 깃허브, 페이스북 주소 등이 될 수 있습니다.
+
authorFBID - 프로필 사진으로 사용할 페이스북 프로필 아이디를 설정합니다.
+
authorImageURL - 작성자 프로필 사진 이미지 URL을 설정합니다. (참고: authorFBID와 authorImageURL를 둘 다 설정한 경우에는 authorFBID 설정이 먼저 적용됩니다. authorImageURL 설정이 적용되기 원한다면 authorFBID 설정은 하지 말아야 합니다.)
+
title - 블로그 포스트 제목을 설정합니다.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
요약 보기
+
블로그 포스트에서 <!--truncate--> 마커를 사용하면 공개된 블로그 포스트의 요약 보기를 제공할 수 있습니다. <!--truncate--> 위에 작성한 내용이 요약 보기로 보여집니다. 예를 들면 아래와 같습니다.
Docusaurus provides an 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 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 twittersite configuration options in siteConfig.js.
+
Advanced Topics
+
블로그 전용으로 사용할 경우
+
You can run your Docusaurus site without a landing page and instead have your blog load first.
+
To do this:
+
+
website/static/ 디렉토리에 index.html 파일을 생성합니다.
+
website/static/index.html 파일에 템플릿으로 제공되는 콘텐츠를 추가합니다.
+
website/static/index.html 파일에서 <title> 태그 내용을 수정합니다.
+
동적인 랜딩 페이지로 만든 website/pages/en/index.js 파일을 삭제합니다.
+
+
+
이제 도큐사우르스를 빌드하게 되면 static/index.html 파일을 복사해서 사이트의 메인 디렉토리에 가져다놓게 됩니다. 방문자가 여러분의 페이지를 찾아오게 되면 정적인 파일을 제공하게 됩니다. When the page loads, it will redirect the visitor to /blog.
+
+
You can use this template:
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/ko/docker.html b/docs/ko/docker.html
new file mode 100644
index 0000000000..33c1ef16fa
--- /dev/null
+++ b/docs/ko/docker.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
\ No newline at end of file
diff --git a/docs/ko/docker/index.html b/docs/ko/docker/index.html
new file mode 100644
index 0000000000..33c1ef16fa
--- /dev/null
+++ b/docs/ko/docker/index.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
\ No newline at end of file
diff --git a/docs/ko/installation.html b/docs/ko/installation.html
new file mode 100644
index 0000000000..d199b7e792
--- /dev/null
+++ b/docs/ko/installation.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
도큐사우루스 설치하기
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
먼저 Node 최신 버전이 설치되어 있어야 합니다. 그리고 Yarn을 미리 설치해놓는 것을 권장합니다.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Create a project, if none exists, and change your directory to this project's root.
+
이 디렉토리에 문서를 만들겁니다. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and website.
+
+
일반적인 경우 기존에 만들었거나 새로 만든 깃허브 프로젝트를 도큐사우르스 사이트 경로로 사용하곤 합니다. 하지만 무조건 그래야 하는 것은 아닙니다.
+
+
npx docusaurus-init을 입력해 도큐사우르스 설치 스크립트를 실행합니다.
+
+
사용하는 Node 버전이 8.2 미만인 경우에는 도큐사우르스를 글로벌로 설치하는 것이 좋습니다. yarn global add docusaurus-init 또는 npm install --global docusaurus-init 명령어를 먼저 실행합니다. 그리고 나서 docusaurus-init 명령어를 사용해 도큐사우르스 설치 스크립트를 실행합니다.
+
+
+
Verifying Installation
+
Along with previously existing files and directories, your root directory will now contain a structure similar to:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
예제 웹사이트 실행하기
+
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. 아래와 같이 예제 웹사이트를 실행할 수 있습니다.
+
+
cd website
+
From within the website directory, run the local web server using yarn start or npm start.
+
Load the example site at http://localhost:3000 if it did not already open automatically. 만일 3000 포트가 이미 사용중이라면, 다른 포트가 사용될 것입니다. 콘솔 메시지를 통해 사용되는 포트를 확인 할 수 있습니다.
+
You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh. 웹사이트 테마에 사용되는 주색상과 보조색상은 랜덤으로 생성됩니다.
+
+
+
프록시 설정을 무시하고 서버 실행하기
+
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 (또는 npm run start)
+
+
Updating Your Docusaurus Version
+
도큐사우르스를 설치한 후에 website 디렉토리 위치에서 yarn outdated docusaurus 또는 npm outdated docusaurus 명령어를 실행하면 최신 버전의 도큐사우르스를 확인할 수 있습니다.
+
You will see something like this:
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
outdated 명령어를 실행했을때 설치할 버전 안내가 없다면 최신 버전이 설치된 상태입니다.
\ No newline at end of file
diff --git a/docs/ko/installation/index.html b/docs/ko/installation/index.html
new file mode 100644
index 0000000000..d199b7e792
--- /dev/null
+++ b/docs/ko/installation/index.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
도큐사우루스 설치하기
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
먼저 Node 최신 버전이 설치되어 있어야 합니다. 그리고 Yarn을 미리 설치해놓는 것을 권장합니다.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Create a project, if none exists, and change your directory to this project's root.
+
이 디렉토리에 문서를 만들겁니다. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and website.
+
+
일반적인 경우 기존에 만들었거나 새로 만든 깃허브 프로젝트를 도큐사우르스 사이트 경로로 사용하곤 합니다. 하지만 무조건 그래야 하는 것은 아닙니다.
+
+
npx docusaurus-init을 입력해 도큐사우르스 설치 스크립트를 실행합니다.
+
+
사용하는 Node 버전이 8.2 미만인 경우에는 도큐사우르스를 글로벌로 설치하는 것이 좋습니다. yarn global add docusaurus-init 또는 npm install --global docusaurus-init 명령어를 먼저 실행합니다. 그리고 나서 docusaurus-init 명령어를 사용해 도큐사우르스 설치 스크립트를 실행합니다.
+
+
+
Verifying Installation
+
Along with previously existing files and directories, your root directory will now contain a structure similar to:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
예제 웹사이트 실행하기
+
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. 아래와 같이 예제 웹사이트를 실행할 수 있습니다.
+
+
cd website
+
From within the website directory, run the local web server using yarn start or npm start.
+
Load the example site at http://localhost:3000 if it did not already open automatically. 만일 3000 포트가 이미 사용중이라면, 다른 포트가 사용될 것입니다. 콘솔 메시지를 통해 사용되는 포트를 확인 할 수 있습니다.
+
You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh. 웹사이트 테마에 사용되는 주색상과 보조색상은 랜덤으로 생성됩니다.
+
+
+
프록시 설정을 무시하고 서버 실행하기
+
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 (또는 npm run start)
+
+
Updating Your Docusaurus Version
+
도큐사우르스를 설치한 후에 website 디렉토리 위치에서 yarn outdated docusaurus 또는 npm outdated docusaurus 명령어를 실행하면 최신 버전의 도큐사우르스를 확인할 수 있습니다.
+
You will see something like this:
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
outdated 명령어를 실행했을때 설치할 버전 안내가 없다면 최신 버전이 설치된 상태입니다.
\ No newline at end of file
diff --git a/docs/ko/publishing.html b/docs/ko/publishing.html
new file mode 100644
index 0000000000..5bdfd2150c
--- /dev/null
+++ b/docs/ko/publishing.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
여러분은 이제 기본 사이트 구조 만들기와 로컬에서 실행하기를 성공적으로 수행했습니다. 이번에는 원하는 형태로 수정하기 과정을 통해 링크를 생성하고 다른 사용자에게 공개하는 방법을 살펴봅니다. 도큐사우르스는 정적인 HTML로 만들어진 웹사이트를 생성합니다. 생성된 HTML 파일을 여러분의 웹서버나 호스팅 업체에서 제공하는 공간에 옮기기만 하면 됩니다.
+
정적 HTML 페이지 만들기
+
여러분의 웹사이트 정적 빌드를 실행하기 위해서는 website 디렉토리 위치에서 아래 명령어를 실행합니다.
+
yarn run build # 또는 `npm run build`
+
+
명령어가 실행되면 build 디렉토리가 website 디렉토리 아래 생성됩니다. 생성된 디렉토리에는 작성한 문서가 .html 파일로 생성되며 pages 디렉토리 안에 있던 콘텐츠도 같이 생성됩니다.
+
정적 HTML 페이지 호스팅하기
+
이제 website/build 디렉토리에 생성된 모든 파일을 여러분이 선택한 웹서버 html 디렉토리 아래로 복사합니다.
+
+
예를 들어, Apache와 Nginx 모두 /var/www/html 기본 컨텐츠 제공 경로 입니다. 어떤 웹서버나 호스팅 업체를 사용할지는 도큐사우르스에서 권할 문제는 아니라 여기서 언급하지는 않겠습니다.
+
+
+
여러분의 웹서버에서 사이트를 서비스하는 경우에는 웹서버에서 적절한 HTTP 헤더값을 가지고 리소스 파일을 제공해주어야 합니다. CSS 파일은 헤더 content-type 값을 text/css으로 설정해야 합니다. Nginx의 경우는 nginx.conf 파일에 include /etc/nginx/mime.types; 을 설정하는 것을 의미합니다. See this issue for more info.
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
GitHub 페이지 활용하기
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
코드 저장소가 프라이빗 상태라고 하더라도 gh-pages 브랜치에 배포되는 내용은 퍼블릭 상태가 됩니다.
+
+
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
파라미터
설명
+
+
+
organizationName
코드 저장소를 소유하고 있는 GitHub 사용자 또는 그룹 계정입니다. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
+
projectName
프로젝트에서 사용하고 있는 GitHub 저장소의 이름입니다. 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
projectName과 organizationName 설정은 siteConfig.js 파일에서 관리하는 것을 권장합니다. 물론, 환경 변수에서 ORGANIZATION_NAME, PROJECT_NAME 값을 지정하는 방법도 사용할 수 있습니다.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
파라미터
설명
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your repositories, this will usually be your own GitHub username. GIT_USER는 organizationName와 projectName의 조합으로 지정된 저장소에 푸시 권한을 가지고 있어야 합니다.
+
+
+
명령행에서 스크립트를 바로 실행하기 위해서는 적절하게 파라미터 값을 채워주어야 합니다.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # 또는 `npm run publish-gh-pages`
+
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 cnamesiteConfig option.
문서를 수정해서 변경된 내용을 사이트에 배포하고자 한다면 위에 있는 명령어를 실행하기만 하면 됩니다. 문서의 변경이 거의 발생하지 않는다면 스크립트를 수동으로 실행하는 방식이 더 좋은 선택입니다. 수동으로 변경된 항목을 배포하는 것은 그리 귀찮은 일은 아닙니다.
+
하지만, 지속적인 통합(CI) 프로세스를 만들고자 한다면 자동으로 배포되는 작업을 구성할 수도 있습니다.
+
지속적인 통합 환경에서 자동으로 배포하기
+
지속적인 통합 (CI) 서비스는 소스 콘트롤에 새로운 커밋이 발생할때마다 반복적으로 발생하는 작업을 처리하기 위해 사용합니다. 지속적인 통합 환경에서는 단위 테스트, 통합 테스트, 자동 빌드, NPM 배포 그리고 변경된 내용을 웹사이트에 배포하기 같은 복합적인 작업을 처리할 수 있습니다. All you need to do to automate the 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
+
Circle Ci에 대한 정보가 필요하다면 setup CircleCI 페이지 정보를 참고하세요. 여러분의 사이트와 문서를 CircleCI를 통해 자동으로 배포하고자 한다면 publish-gh-pages 스크립트가 배포 단계에서 실행될 수 있도록 Circle 설정을 변경해주기만 하면 됩니다. 아래와 같은 단계로 설정을 변경할 수 있습니다.
+
+
GIT_USER에 설정한 GitHub 사용자 계정은 문서가 있는 저장소 쓰기 권한을 가지고 있어야 합니다. 저장소에서 Settings | Collaborators & teams 메뉴에서 설정을 변경할 수 있습니다.
+
GIT_USER에 지정한 사용자로 GitHub 사이트에 로그인합니다.
+
Https://github.com/settings/tokens URL로 접근해서 GIT_USER를 위한 personal access token을 생성합니다. 접근 범위 설정 시 repository를 선택하면 프라이빗 저장소에 대한 모든 권한을 부여할 수 있습니다. 생성한 토큰은 안전한 곳에 보관하고 외부에 노출되지 않도록 합니다. 토큰은 GitHub 비밀번호를 대신해 GitHub에서 처리하고자하는 모든 작업에 대한 인증 작업을 수행합니다.
+
Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". URL은 https://circleci.com/gh/ORG/REPO/edit#env-vars와 같은 형식인데, "ORG/REPO" 부분은 여러분의 GitHub 그룹 계정/저장소로 변경합니다.
+
GITHUB_TOKEN라는 이름으로 새로운 환경 변수를 생성하고 앞에서 생성된 액세스 토큰을 값으로 지정합니다.
+
.circleci 이라는 이름으로 디렉토리를 생성하고 config.yml 파일을 만들어서 넣어줍니다.
+
아래에 있는 내용을 .circleci/config.yml 파일에 채워줍니다.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER>와 <GITHUB_USERNAME>은 같은 값을 사용합니다.
+
DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 5.
+
+
GitHub 저장소 접근 시 SSH를 사용하고자 한다면 USE_SSH=true을 설정하면 됩니다. SSH 설정을 적용하면 설정된 값은 다음과 같은 형식이 됩니다. 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.
+
+
이제 master 브랜치에 새로운 커밋이 발생하게 되면 CircleCI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.
+
+
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.
+
+
팁 & 트릭
+
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 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"
+
+
config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.
Travis CI 대시보드를 실행합니다. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
GH_TOKEN라는 이름으로 새로운 환경 변수를 만들고 이전 단계에서 생성한 토큰을 값으로 지정합니다. 그리고 GH_EMAIL (이메일 주소), GH_NAME (GitHub 사용자 계정) 환경 변수값도 설정합니다.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
빌드 명령어를 다음과 같이 입력합니다. cd website; npm install; npm run build;
+
배포할 디렉토리는 다음과 같습니다. website/build/<projectName> (projectName은 siteConfig에서 설정합니다).
+
+
Click Deploy site
+
+
Netlify 설정을 통해 저장소에 커밋이 발생할때마다 빌드를 처리할 수도 있고 master 브랜치에 커밋이 발생할때만 빌드가 실행될 수 있습니다.
+
Hosting on Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
배포할 브랜치를 선택합니다. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
\ No newline at end of file
diff --git a/docs/ko/publishing/index.html b/docs/ko/publishing/index.html
new file mode 100644
index 0000000000..5bdfd2150c
--- /dev/null
+++ b/docs/ko/publishing/index.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
여러분은 이제 기본 사이트 구조 만들기와 로컬에서 실행하기를 성공적으로 수행했습니다. 이번에는 원하는 형태로 수정하기 과정을 통해 링크를 생성하고 다른 사용자에게 공개하는 방법을 살펴봅니다. 도큐사우르스는 정적인 HTML로 만들어진 웹사이트를 생성합니다. 생성된 HTML 파일을 여러분의 웹서버나 호스팅 업체에서 제공하는 공간에 옮기기만 하면 됩니다.
+
정적 HTML 페이지 만들기
+
여러분의 웹사이트 정적 빌드를 실행하기 위해서는 website 디렉토리 위치에서 아래 명령어를 실행합니다.
+
yarn run build # 또는 `npm run build`
+
+
명령어가 실행되면 build 디렉토리가 website 디렉토리 아래 생성됩니다. 생성된 디렉토리에는 작성한 문서가 .html 파일로 생성되며 pages 디렉토리 안에 있던 콘텐츠도 같이 생성됩니다.
+
정적 HTML 페이지 호스팅하기
+
이제 website/build 디렉토리에 생성된 모든 파일을 여러분이 선택한 웹서버 html 디렉토리 아래로 복사합니다.
+
+
예를 들어, Apache와 Nginx 모두 /var/www/html 기본 컨텐츠 제공 경로 입니다. 어떤 웹서버나 호스팅 업체를 사용할지는 도큐사우르스에서 권할 문제는 아니라 여기서 언급하지는 않겠습니다.
+
+
+
여러분의 웹서버에서 사이트를 서비스하는 경우에는 웹서버에서 적절한 HTTP 헤더값을 가지고 리소스 파일을 제공해주어야 합니다. CSS 파일은 헤더 content-type 값을 text/css으로 설정해야 합니다. Nginx의 경우는 nginx.conf 파일에 include /etc/nginx/mime.types; 을 설정하는 것을 의미합니다. See this issue for more info.
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
GitHub 페이지 활용하기
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
코드 저장소가 프라이빗 상태라고 하더라도 gh-pages 브랜치에 배포되는 내용은 퍼블릭 상태가 됩니다.
+
+
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
파라미터
설명
+
+
+
organizationName
코드 저장소를 소유하고 있는 GitHub 사용자 또는 그룹 계정입니다. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
+
projectName
프로젝트에서 사용하고 있는 GitHub 저장소의 이름입니다. 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
projectName과 organizationName 설정은 siteConfig.js 파일에서 관리하는 것을 권장합니다. 물론, 환경 변수에서 ORGANIZATION_NAME, PROJECT_NAME 값을 지정하는 방법도 사용할 수 있습니다.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
파라미터
설명
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your repositories, this will usually be your own GitHub username. GIT_USER는 organizationName와 projectName의 조합으로 지정된 저장소에 푸시 권한을 가지고 있어야 합니다.
+
+
+
명령행에서 스크립트를 바로 실행하기 위해서는 적절하게 파라미터 값을 채워주어야 합니다.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # 또는 `npm run publish-gh-pages`
+
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 cnamesiteConfig option.
문서를 수정해서 변경된 내용을 사이트에 배포하고자 한다면 위에 있는 명령어를 실행하기만 하면 됩니다. 문서의 변경이 거의 발생하지 않는다면 스크립트를 수동으로 실행하는 방식이 더 좋은 선택입니다. 수동으로 변경된 항목을 배포하는 것은 그리 귀찮은 일은 아닙니다.
+
하지만, 지속적인 통합(CI) 프로세스를 만들고자 한다면 자동으로 배포되는 작업을 구성할 수도 있습니다.
+
지속적인 통합 환경에서 자동으로 배포하기
+
지속적인 통합 (CI) 서비스는 소스 콘트롤에 새로운 커밋이 발생할때마다 반복적으로 발생하는 작업을 처리하기 위해 사용합니다. 지속적인 통합 환경에서는 단위 테스트, 통합 테스트, 자동 빌드, NPM 배포 그리고 변경된 내용을 웹사이트에 배포하기 같은 복합적인 작업을 처리할 수 있습니다. All you need to do to automate the 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
+
Circle Ci에 대한 정보가 필요하다면 setup CircleCI 페이지 정보를 참고하세요. 여러분의 사이트와 문서를 CircleCI를 통해 자동으로 배포하고자 한다면 publish-gh-pages 스크립트가 배포 단계에서 실행될 수 있도록 Circle 설정을 변경해주기만 하면 됩니다. 아래와 같은 단계로 설정을 변경할 수 있습니다.
+
+
GIT_USER에 설정한 GitHub 사용자 계정은 문서가 있는 저장소 쓰기 권한을 가지고 있어야 합니다. 저장소에서 Settings | Collaborators & teams 메뉴에서 설정을 변경할 수 있습니다.
+
GIT_USER에 지정한 사용자로 GitHub 사이트에 로그인합니다.
+
Https://github.com/settings/tokens URL로 접근해서 GIT_USER를 위한 personal access token을 생성합니다. 접근 범위 설정 시 repository를 선택하면 프라이빗 저장소에 대한 모든 권한을 부여할 수 있습니다. 생성한 토큰은 안전한 곳에 보관하고 외부에 노출되지 않도록 합니다. 토큰은 GitHub 비밀번호를 대신해 GitHub에서 처리하고자하는 모든 작업에 대한 인증 작업을 수행합니다.
+
Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". URL은 https://circleci.com/gh/ORG/REPO/edit#env-vars와 같은 형식인데, "ORG/REPO" 부분은 여러분의 GitHub 그룹 계정/저장소로 변경합니다.
+
GITHUB_TOKEN라는 이름으로 새로운 환경 변수를 생성하고 앞에서 생성된 액세스 토큰을 값으로 지정합니다.
+
.circleci 이라는 이름으로 디렉토리를 생성하고 config.yml 파일을 만들어서 넣어줍니다.
+
아래에 있는 내용을 .circleci/config.yml 파일에 채워줍니다.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER>와 <GITHUB_USERNAME>은 같은 값을 사용합니다.
+
DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 5.
+
+
GitHub 저장소 접근 시 SSH를 사용하고자 한다면 USE_SSH=true을 설정하면 됩니다. SSH 설정을 적용하면 설정된 값은 다음과 같은 형식이 됩니다. 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.
+
+
이제 master 브랜치에 새로운 커밋이 발생하게 되면 CircleCI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.
+
+
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.
+
+
팁 & 트릭
+
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 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"
+
+
config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.
Travis CI 대시보드를 실행합니다. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
GH_TOKEN라는 이름으로 새로운 환경 변수를 만들고 이전 단계에서 생성한 토큰을 값으로 지정합니다. 그리고 GH_EMAIL (이메일 주소), GH_NAME (GitHub 사용자 계정) 환경 변수값도 설정합니다.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
빌드 명령어를 다음과 같이 입력합니다. cd website; npm install; npm run build;
+
배포할 디렉토리는 다음과 같습니다. website/build/<projectName> (projectName은 siteConfig에서 설정합니다).
+
+
Click Deploy site
+
+
Netlify 설정을 통해 저장소에 커밋이 발생할때마다 빌드를 처리할 수도 있고 master 브랜치에 커밋이 발생할때만 빌드가 실행될 수 있습니다.
+
Hosting on Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
배포할 브랜치를 선택합니다. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
\ No newline at end of file
diff --git a/docs/ko/search.html b/docs/ko/search.html
new file mode 100644
index 0000000000..d9bce3f4c2
--- /dev/null
+++ b/docs/ko/search.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
도큐사우르스에서는 Algolia 문서 검색 기능을 지원합니다. 여러분의 웹사이트가 온라인 상태라면 DocSearch에 요청하기를 할 수 있습니다. Algolia에서 인증 코드를 보내주면 siteConfig.js 파일에 추가합니다.
+
DocSearch는 매일 24시간동안 여러분의 웹사이트 콘텐츠를 수집해서 Algolia 인덱스에 모든 콘텐츠를 추가합니다. 여러분의 웹사이트에서 Algolia API를 사용해 수집된 콘텐츠에 대해 질의를 던질 수 있습니다. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). 이 서비스는 무료입니다.
+
검색창 활성화하기
+
siteConfig.js 파일의 algolia 항목에서 API 키와 인덱스명(Algolia에서 보내준)을 입력하면 웹사이트에서 검색 기능을 사용할 수 있습니다.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ 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.
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.
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:
\ No newline at end of file
diff --git a/docs/ko/search/index.html b/docs/ko/search/index.html
new file mode 100644
index 0000000000..d9bce3f4c2
--- /dev/null
+++ b/docs/ko/search/index.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
도큐사우르스에서는 Algolia 문서 검색 기능을 지원합니다. 여러분의 웹사이트가 온라인 상태라면 DocSearch에 요청하기를 할 수 있습니다. Algolia에서 인증 코드를 보내주면 siteConfig.js 파일에 추가합니다.
+
DocSearch는 매일 24시간동안 여러분의 웹사이트 콘텐츠를 수집해서 Algolia 인덱스에 모든 콘텐츠를 추가합니다. 여러분의 웹사이트에서 Algolia API를 사용해 수집된 콘텐츠에 대해 질의를 던질 수 있습니다. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). 이 서비스는 무료입니다.
+
검색창 활성화하기
+
siteConfig.js 파일의 algolia 항목에서 API 키와 인덱스명(Algolia에서 보내준)을 입력하면 웹사이트에서 검색 기능을 사용할 수 있습니다.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ 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.
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.
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:
\ No newline at end of file
diff --git a/docs/ko/site-config.html b/docs/ko/site-config.html
new file mode 100644
index 0000000000..ec0bd6915e
--- /dev/null
+++ b/docs/ko/site-config.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
A large part of the site configuration is done by editing the siteConfig.js file.
+
User Showcase
+
The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.
+
Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.
+
siteConfig Fields
+
The siteConfig object contains the bulk of the configuration settings for your website.
+
Mandatory Fields
+
baseUrl [string]
+
baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For URLs that have no path, the baseUrl should be set to /. This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor is the color used the header navigation bar and sidebars.
+
secondaryColor is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile).
+
Custom color configurations can also be added. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
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.
+
Example Usage:
+
headerLinks: [
+ // Links to document with id doc1 for current language/version
+ { doc: "doc1", label: "Getting Started" },
+ // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
+ { page: "help", label: "Help" },
+ // Links to href destination, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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.
+
Optional Fields
+
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.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ No newline at end of file
diff --git a/docs/ko/site-config/index.html b/docs/ko/site-config/index.html
new file mode 100644
index 0000000000..ec0bd6915e
--- /dev/null
+++ b/docs/ko/site-config/index.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
A large part of the site configuration is done by editing the siteConfig.js file.
+
User Showcase
+
The users array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Each user object should have caption, image, infoLink, and pinned fields. The caption is the text showed when someone hovers over the image of that user, and the infoLink is where clicking the image will bring someone. The pinned field determines whether or not it shows up on the index page.
+
Currently, this users array is used only by the index.js and users.js example files. If you do not wish to have a users page or show users on the index page, you may remove this section.
+
siteConfig Fields
+
The siteConfig object contains the bulk of the configuration settings for your website.
+
Mandatory Fields
+
baseUrl [string]
+
baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. For URLs that have no path, the baseUrl should be set to /. This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor is the color used the header navigation bar and sidebars.
+
secondaryColor is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile).
+
Custom color configurations can also be added. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
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.
+
Example Usage:
+
headerLinks: [
+ // Links to document with id doc1 for current language/version
+ { doc: "doc1", label: "Getting Started" },
+ // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
+ { page: "help", label: "Help" },
+ // Links to href destination, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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.
+
Optional Fields
+
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.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ No newline at end of file
diff --git a/docs/ko/tutorial-create-pages.html b/docs/ko/tutorial-create-pages.html
new file mode 100644
index 0000000000..c9aeb7c690
--- /dev/null
+++ b/docs/ko/tutorial-create-pages.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/ko/tutorial-create-pages/index.html b/docs/ko/tutorial-create-pages/index.html
new file mode 100644
index 0000000000..c9aeb7c690
--- /dev/null
+++ b/docs/ko/tutorial-create-pages/index.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/ko/tutorial-version.html b/docs/ko/tutorial-version.html
new file mode 100644
index 0000000000..b85cbc5fcc
--- /dev/null
+++ b/docs/ko/tutorial-version.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ No newline at end of file
diff --git a/docs/ko/tutorial-version/index.html b/docs/ko/tutorial-version/index.html
new file mode 100644
index 0000000000..b85cbc5fcc
--- /dev/null
+++ b/docs/ko/tutorial-version/index.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ No newline at end of file
diff --git a/docs/pt-BR/adding-blog.html b/docs/pt-BR/adding-blog.html
new file mode 100644
index 0000000000..90b3b6d8aa
--- /dev/null
+++ b/docs/pt-BR/adding-blog.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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. Como você já deve ter adivinhado, a data do post é extraída do nome do arquivo.
+
For example, at website/blog/2017-12-14-introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
Opções do cabeçalho
+
The only required field is title; however, we provide options to add author information to your blog post as well along with other options.
+
+
author - O nome do autor como ele vai aparecer dentro do post.
+
authorURL - O link associado com o autor. Pode ser um perfil do Twitter, Facebook, GitHub, etc.
+
authorFBID - O ID do perfil do Facebook do autor, usado para se obter a foto de perfil dele.
+
authorImageURL - O link para a imagem do autor. (Nota: Se você usa ambos o authorFBID e authorImageURL, authorFBID vai ter prioridade. Não inclua authorFBID se você quiser que authorImageURL apareça.)
+
title - O título do post.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
Definindo um resumo para o post
+
Use o marcador <!--truncate--> no seu post para demarcar a parte do seu post que será mostrada como resumo ao visualizar todos os posts publicados. Tudo que estiver sobre <!--truncate--> será parte do resumo. Por exemplo:
Alterando o número de posts mostrados na barra lateral
+
Por padrão, são mostrados na barra lateral os 5 posts mais recentes.
+
Você pode mudar a quantidade de posts mostrada ao adicionar uma configuração blogSidebarCount ao seu siteConfig.js.
+
As opções disponíveis são um inteiro representando o número de posts desejado ou uma string com o valor 'ALL'.
+
Exemplo:
+
blogSidebarCount: 'ALL',
+
+
Alterando o título da barra lateral
+
Você pode definir um título específico para a barra lateral adicionando uma configuração blogSidebarTitle ao seu siteConfig.js.
+
A opção é um objeto que pode ter as chaves default e all. O valor da chave default será o título padrão da barra lateral. O valor da chave all será o título da barra lateral caso a opção blogSidebarCount tenha sido configurada como 'ALL'.
Docusaurus provides an RSS feed for your blog posts. Ambos os formatos RSS e Atom são compatíveis. This data is automatically added to your website page's HTML <HEAD> tag.
+
No feed RSS, é fornecido um resumo do texto do post até o marcador <!--truncate-->. If no <!--truncate--> tag is found, then all text up to 250 characters are used.
+
Botões de redes sociais
+
Se você quiser adicionar botões para o Facebook e/ou Twitter ao fim de seus posts, defina as opções de configuração do sitefacebookAppId e/ou twitter lá no siteConfig.js.
+
Tópicos avançados
+
Quero que meu site seja somente um blog.
+
Você pode fazer com que o site Docusaurus mostre o seu blog como página inicial ao invés de uma landing page.
+
Para isso:
+
+
Crie um arquivo index.html em website/static/.
+
Coloque o conteúdo do modelo abaixo em website/static/index.html
+
Personalize o <title> de website/static/index.html
+
Exclua a landing page dinâmica website/pages/en/index.js
+
+
+
Agora, quando o Docusaurus gerar ou construir o seu site, ele vai copiar o conteúdo de static/index.html e colocá-lo no diretório principal do site. O arquivo estático é servido quando um visitante chega em sua página. When the page loads, it will redirect the visitor to /blog.
+
+
Você pode usar este modelo:
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/pt-BR/adding-blog/index.html b/docs/pt-BR/adding-blog/index.html
new file mode 100644
index 0000000000..90b3b6d8aa
--- /dev/null
+++ b/docs/pt-BR/adding-blog/index.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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. Como você já deve ter adivinhado, a data do post é extraída do nome do arquivo.
+
For example, at website/blog/2017-12-14-introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
Opções do cabeçalho
+
The only required field is title; however, we provide options to add author information to your blog post as well along with other options.
+
+
author - O nome do autor como ele vai aparecer dentro do post.
+
authorURL - O link associado com o autor. Pode ser um perfil do Twitter, Facebook, GitHub, etc.
+
authorFBID - O ID do perfil do Facebook do autor, usado para se obter a foto de perfil dele.
+
authorImageURL - O link para a imagem do autor. (Nota: Se você usa ambos o authorFBID e authorImageURL, authorFBID vai ter prioridade. Não inclua authorFBID se você quiser que authorImageURL apareça.)
+
title - O título do post.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
Definindo um resumo para o post
+
Use o marcador <!--truncate--> no seu post para demarcar a parte do seu post que será mostrada como resumo ao visualizar todos os posts publicados. Tudo que estiver sobre <!--truncate--> será parte do resumo. Por exemplo:
Alterando o número de posts mostrados na barra lateral
+
Por padrão, são mostrados na barra lateral os 5 posts mais recentes.
+
Você pode mudar a quantidade de posts mostrada ao adicionar uma configuração blogSidebarCount ao seu siteConfig.js.
+
As opções disponíveis são um inteiro representando o número de posts desejado ou uma string com o valor 'ALL'.
+
Exemplo:
+
blogSidebarCount: 'ALL',
+
+
Alterando o título da barra lateral
+
Você pode definir um título específico para a barra lateral adicionando uma configuração blogSidebarTitle ao seu siteConfig.js.
+
A opção é um objeto que pode ter as chaves default e all. O valor da chave default será o título padrão da barra lateral. O valor da chave all será o título da barra lateral caso a opção blogSidebarCount tenha sido configurada como 'ALL'.
Docusaurus provides an RSS feed for your blog posts. Ambos os formatos RSS e Atom são compatíveis. This data is automatically added to your website page's HTML <HEAD> tag.
+
No feed RSS, é fornecido um resumo do texto do post até o marcador <!--truncate-->. If no <!--truncate--> tag is found, then all text up to 250 characters are used.
+
Botões de redes sociais
+
Se você quiser adicionar botões para o Facebook e/ou Twitter ao fim de seus posts, defina as opções de configuração do sitefacebookAppId e/ou twitter lá no siteConfig.js.
+
Tópicos avançados
+
Quero que meu site seja somente um blog.
+
Você pode fazer com que o site Docusaurus mostre o seu blog como página inicial ao invés de uma landing page.
+
Para isso:
+
+
Crie um arquivo index.html em website/static/.
+
Coloque o conteúdo do modelo abaixo em website/static/index.html
+
Personalize o <title> de website/static/index.html
+
Exclua a landing page dinâmica website/pages/en/index.js
+
+
+
Agora, quando o Docusaurus gerar ou construir o seu site, ele vai copiar o conteúdo de static/index.html e colocá-lo no diretório principal do site. O arquivo estático é servido quando um visitante chega em sua página. When the page loads, it will redirect the visitor to /blog.
+
+
Você pode usar este modelo:
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/pt-BR/docker.html b/docs/pt-BR/docker.html
new file mode 100644
index 0000000000..4af310c3cf
--- /dev/null
+++ b/docs/pt-BR/docker.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
Docker é uma ferramenta que lhe permite criar, implantar e gerenciar pacotes leves que contém todo o necessário para executar uma aplicação. Isto pode nos ajudar a evitar conflitos de dependências e comportamentos indesejados ao executar o Docusaurus.
Build the docker image -- Enter the folder where you have Docusaurus installed. Depois, execute docker build -t docusaurus-doc .
+
Assim que o processo for concluído, você poderá verificar se a imagem existe usando o comando docker images.
+
+
Agora, incluímos um Dockerfile quando você instala o Docusaurus.
+
+
Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc
+
Isso iniciará um contêiner do Docker com a imagem docusaurus-doc. Para ver informações detalhadas do contêiner, use o docker ps .
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
Usando o docker-composer
+
Também é possível usar o docker-compose para configurar a nossa aplicação. Esta funcionalidade do Docker permite que você rode o servidor web e quaisquer serviços adicionais com um único comando.
+
+
Compose é uma ferramenta para definir e executar aplicações em vários serviços do Docker. Com a Compose, você usa um arquivo YAML para configurar os serviços do seu aplicativo. Em seguida, com um único comando, você cria e inicia todos os serviços a partir de sua configuração.
+
+
Usar Compor é um processo de três passos:
+
+
Define your app’s environment with a Dockerfile so it can be reproduced anywhere.
+
Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.
+
Run docker-compose up and Compose starts and runs your entire app.
+
+
We include a basic docker-compose.yml in your project:
\ No newline at end of file
diff --git a/docs/pt-BR/docker/index.html b/docs/pt-BR/docker/index.html
new file mode 100644
index 0000000000..4af310c3cf
--- /dev/null
+++ b/docs/pt-BR/docker/index.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
Docker é uma ferramenta que lhe permite criar, implantar e gerenciar pacotes leves que contém todo o necessário para executar uma aplicação. Isto pode nos ajudar a evitar conflitos de dependências e comportamentos indesejados ao executar o Docusaurus.
Build the docker image -- Enter the folder where you have Docusaurus installed. Depois, execute docker build -t docusaurus-doc .
+
Assim que o processo for concluído, você poderá verificar se a imagem existe usando o comando docker images.
+
+
Agora, incluímos um Dockerfile quando você instala o Docusaurus.
+
+
Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc
+
Isso iniciará um contêiner do Docker com a imagem docusaurus-doc. Para ver informações detalhadas do contêiner, use o docker ps .
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
Usando o docker-composer
+
Também é possível usar o docker-compose para configurar a nossa aplicação. Esta funcionalidade do Docker permite que você rode o servidor web e quaisquer serviços adicionais com um único comando.
+
+
Compose é uma ferramenta para definir e executar aplicações em vários serviços do Docker. Com a Compose, você usa um arquivo YAML para configurar os serviços do seu aplicativo. Em seguida, com um único comando, você cria e inicia todos os serviços a partir de sua configuração.
+
+
Usar Compor é um processo de três passos:
+
+
Define your app’s environment with a Dockerfile so it can be reproduced anywhere.
+
Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.
+
Run docker-compose up and Compose starts and runs your entire app.
+
+
We include a basic docker-compose.yml in your project:
\ No newline at end of file
diff --git a/docs/pt-BR/installation.html b/docs/pt-BR/installation.html
new file mode 100644
index 0000000000..d77197c8e2
--- /dev/null
+++ b/docs/pt-BR/installation.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
O Docusaurus foi projetado desde o início para ser facilmente instalado e usado, para que você crie seu site rapidamente e sem muito esforço.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Instalando o Docusaurus
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
Verifique se você tem a versão mais recente do Node instalada. Recomendamos que você também instale o Yarn.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Create a project, if none exists, and change your directory to this project's root.
+
Você estará criando a documentação neste diretório. O Diretório principal conterá outros arquivos. O script de instalação do Docusaurus Criará doas novas pastas: docs e website.
+
+
Na maioria das vezes, o local do seu site Docusaurus será um projeto do GitHub, seja ele um já existente ou um recém-criado, mas isso não é obrigatório para que o Docusaurus seja usado.
+
+
Execute o script de instalação do Docusaurus: npx docusaurus-init.
+
+
Se você não tiver o Node a partir da versão 8.2 ou caso prefira instalar o Docusaurus globalmente, execute yarn global add docusaurus-init ou npm install --global docusaurus-init. Depois disso, execute docusaurus-init.
+
+
+
Verificando a instalação
+
Juntamente com as pastas e arquivos existentes, seu diretório raiz agora vai conter uma estrutura semelhante a esta:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
Rodando o site de exemplo
+
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. Para rodá-lo:
+
+
cd website
+
From within the website directory, run the local web server using yarn start or npm start.
+
Load the example site at http://localhost:3000 if it did not already open automatically. Se a porta 3000 já estiver em uso, outra porta será usada. Olhe para as mensagens do console para ver qual é.
+
Agora você deve estar vendo o site de exemplo carregado no seu navegador web. Também tem um servidor LiveReload rodando - ou seja, quaisquer alterações que você fizer nos documentos e arquivos no diretório website farão a página recarregar automaticamente. Uma cor de tema primária e secundária gerada aleatoriamente será escolhida para você.
+
+
+
Iniciando o servidor por trás de um proxy
+
Se sua conexão com a Internet estiver por trás de um proxy corporativo, você precisa desativá-lo para que as requisições para o servidor de desenvolvimento funcionem adequadamente. Isso pode ser feito usando a variável de ambiente NO_PROXY.
+
SET NO_PROXY=localhost
+yarn start (ou npm run start)
+
+
Atualizando sua versão do Docusaurus
+
A qualquer momento após o Docusaurus ser instalado, você poderá verificar a versão atualmente instalada dele indo até o diretório website e executando yarn outdated docusaurus ou npm outdated docusaurus.
+
Você verá algo assim:
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
Se os comandos outdated não retornarem nenhuma versão perceptível, então você está atualizado.
Caso você comece a receber erros após a atualização, tente ou limpar seu cache do Babel (geralmente está em um diretório temporário) ou rodar o servidor do Docusaurus (ex.: yarn start) com a configuração de ambiente BABEL_DISABLE_CACHE=1.
\ No newline at end of file
diff --git a/docs/pt-BR/installation/index.html b/docs/pt-BR/installation/index.html
new file mode 100644
index 0000000000..d77197c8e2
--- /dev/null
+++ b/docs/pt-BR/installation/index.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
O Docusaurus foi projetado desde o início para ser facilmente instalado e usado, para que você crie seu site rapidamente e sem muito esforço.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Instalando o Docusaurus
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
Verifique se você tem a versão mais recente do Node instalada. Recomendamos que você também instale o Yarn.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Create a project, if none exists, and change your directory to this project's root.
+
Você estará criando a documentação neste diretório. O Diretório principal conterá outros arquivos. O script de instalação do Docusaurus Criará doas novas pastas: docs e website.
+
+
Na maioria das vezes, o local do seu site Docusaurus será um projeto do GitHub, seja ele um já existente ou um recém-criado, mas isso não é obrigatório para que o Docusaurus seja usado.
+
+
Execute o script de instalação do Docusaurus: npx docusaurus-init.
+
+
Se você não tiver o Node a partir da versão 8.2 ou caso prefira instalar o Docusaurus globalmente, execute yarn global add docusaurus-init ou npm install --global docusaurus-init. Depois disso, execute docusaurus-init.
+
+
+
Verificando a instalação
+
Juntamente com as pastas e arquivos existentes, seu diretório raiz agora vai conter uma estrutura semelhante a esta:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
Rodando o site de exemplo
+
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. Para rodá-lo:
+
+
cd website
+
From within the website directory, run the local web server using yarn start or npm start.
+
Load the example site at http://localhost:3000 if it did not already open automatically. Se a porta 3000 já estiver em uso, outra porta será usada. Olhe para as mensagens do console para ver qual é.
+
Agora você deve estar vendo o site de exemplo carregado no seu navegador web. Também tem um servidor LiveReload rodando - ou seja, quaisquer alterações que você fizer nos documentos e arquivos no diretório website farão a página recarregar automaticamente. Uma cor de tema primária e secundária gerada aleatoriamente será escolhida para você.
+
+
+
Iniciando o servidor por trás de um proxy
+
Se sua conexão com a Internet estiver por trás de um proxy corporativo, você precisa desativá-lo para que as requisições para o servidor de desenvolvimento funcionem adequadamente. Isso pode ser feito usando a variável de ambiente NO_PROXY.
+
SET NO_PROXY=localhost
+yarn start (ou npm run start)
+
+
Atualizando sua versão do Docusaurus
+
A qualquer momento após o Docusaurus ser instalado, você poderá verificar a versão atualmente instalada dele indo até o diretório website e executando yarn outdated docusaurus ou npm outdated docusaurus.
+
Você verá algo assim:
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
Se os comandos outdated não retornarem nenhuma versão perceptível, então você está atualizado.
Caso você comece a receber erros após a atualização, tente ou limpar seu cache do Babel (geralmente está em um diretório temporário) ou rodar o servidor do Docusaurus (ex.: yarn start) com a configuração de ambiente BABEL_DISABLE_CACHE=1.
\ No newline at end of file
diff --git a/docs/pt-BR/publishing.html b/docs/pt-BR/publishing.html
new file mode 100644
index 0000000000..a9c78c4caa
--- /dev/null
+++ b/docs/pt-BR/publishing.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
Agora você já deve ter um site pronto rodando localmente. Assim que você tiver terminado de personalizar ele para ficar nos trinques, é hora de publicá-lo. O Docusaurus gera um site estático HTML prontinho para ser servido pelo seu servidor ou solução de hospedagem favorito.
+
Gerando páginas estáticas HTML
+
Para criar uma versão estática do seu site, execute o seguinte script no diretório website:
+
yarn run build # ou `npm run build`
+
+
Isso vai gerar um diretório build dentro do diretório website contendo os arquivos .html da sua documentação e de outras páginas incluídas em pages.
+
Hospedando páginas estáticas HTML
+
Neste ponto, você já pode pegar todos os arquivos dentro do diretório website/build e copiar eles diretamente para o diretório html do seu servidor web favorito.
+
+
For example, both Apache and Nginx serve content from /var/www/html by default. Com isso dito, escolher onde você vai hospedar seu site está fora do escopo do Docusaurus.
+
+
+
Ao servir o site a partir de seu próprio servidor web, certifique-se de que ele esteja servindo os arquivos de assets com os cabeçalhos HTTP adequados. Arquivos CSS devem ser servidos com o cabeçalho de content-type como 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.
Run a single command inside the root directory of your project:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Usando o GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
Mesmo que seu repositório seja privado, qualquer coisa publicada em uma branch gh-pages será pública.
+
+
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
Nome
Descrição
+
+
+
organizationName
O usuário ou organização que é dona do repositório. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
+
projectName
O nome do repositório do seu projeto no GitHub. 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
Por mais que recomendemos configurar o projectName e o organizationName no siteConfig.js, você também pode usar as variáveis de ambiente ORGANIZATION_NAME e PROJECT_NAME.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
Nome
Descrição
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your repositories, this will usually be your own GitHub username. O GIT_USER especificado precisa ter acesso de push no repositório especificado pela combinação de organizationName e projectName.
+
+
+
Para rodar o script diretamente da linha de comando, você pode usar o seguinte comando, preenchendo os valores de parâmetros conforme apropriado.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # ou `npm run publish-gh-pages`
+
Há também dois parâmetros opcionais que são definidos como variáveis de ambiente:
+
+
+
Nome
Descrição
+
+
+
USE_SSH
Se definida como true, a conexão ao repositório do GitHub será feita por meio de SSH, ao invés de HTTPS. HTTPS é o padrão se essa variável não for definida.
+
CURRENT_BRANCH
A branch que contém as alterações na documentação mais recentes que serão publicadas. Geralmente, essa branch será a master, mas poderia ser qualquer branch (padrão ou não) exceto pela gh-pages. Se nada for definido para essa variável, então a branch atual será usada.
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 cnamesiteConfig option.
+
Recomendamos fortemente que você leia a documentação do GitHub Pages para saber mais sobre como essa solução de hospedagem funciona.
+
Você pode executar o comando acima a qualquer momento que você atualizar sua documentação e desejar publicar as alterações no seu site. Executar o script manualmente pode funcionar bem para sites onde a documentação raramente muda e não seja muito inconveniente lembrar de publicar as alterações manualmente.
+
No entanto, você pode automatizar o processo de publicação com integração contínua (CI).
+
Automatizando deploys usando integração contínua
+
Serviços de integração contínua (CI) são normalmente usados para realizar tarefas de rotina sempre que novos commits são enviados para o controle de código fonte. Dentre essas tarefas estão a execução de testes unitários e de integração, a automatização de builds, a publicação de pacotes ao NPM e, sim, a implementação de alterações ao seu site. All you need to do to automate the 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.
+
Usando CircleCI 2.0
+
Se ainda não tiver o feito, você pode configurar o CircleCI para seu projeto de código aberto. Depois disso, para poder fazer o deploy automático do seu site e documentação via CircleCI, basta configurar o Circle para executar o script publish-gh-pages como parte do processo de deploy. Você pode seguir este passo-a-passo para configurar certinho:
+
+
Tenha certeza que a conta do GitHub que vai ser definida como GIT_USER tem acesso de escrita (write) ao repositório que contém a documentação. Você pode ver isso em Settings | Collaborators & teams no repositório.
+
Faça login no GitHub como o GIT_USER.
+
Vá para https://github.com/settings/tokens como o GIT_USER e gere um novo token de acesso pessoal, concedendo a ele controle total sobre repositórios privados através do escopo de acesso repository. Guarde este token em um lugar seguro, e tenha certeza de não compartilhar ele com ninguém. Este token pode ser usado para autenticar e realizar ações em seu nome, como se fosse a sua senha do GitHub.
+
Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". O URL é algo como https://circleci.com/gh/ORG/REPO/edit#env-vars, onde "ORG/REPO" deve ser substituído pela sua própria organização/repositório do seu GitHub.
+
Crie uma nova variável de ambiente chamada GITHUB_TOKEN, usando seu token de acesso recém-criado como o valor dela.
+
Crie um diretório .circleci e crie um arquivo config.yml dentro dele.
+
Copie o texto abaixo para o .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
Não se esqueça de substituir todos os <....> na sequência command: com os valores adequados. Como <GIT_USER>, você pode definir uma conta do GitHub que tenha permissão de push na documentação do seu repositório do GitHub. Na maioria das vezes, <GIT_USER> e <GITHUB_USERNAME> serão a mesma coisa.
+
DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 5.
+
+
Se você quiser usar SSH para a conexão com o seu repositório GitHub, você pode configurar USE_SSH=true. Dessa forma, o comando acima seria algo como: 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.
+
+
Agora, sempre que um novo commit pintar na branch master, o CircleCI vai rodar sua bateria de testes e, se tudo passar, seu site será publicado através do script publish-gh-pages.
+
+
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.
+
+
Truques e dicas
+
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 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"Pulando testes na branch gh-pages"
+
+
Salve este arquivo como config.yml e coloque-o em um diretório .circleci dentro do seu diretório website/static.
Abra seu painel do Travis CI. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
Crie uma nova variável de ambiente chamada GH_TOKEN com seu token recém-criado como seu valor. Depois, crie GH_EMAIL (seu endereço de e-mail) e GH_NAME (seu nome de usuário do GitHub).
+
Crie um .travis.yml na raiz do seu repositório contendo o texto abaixo.
Agora, sempre que um novo commit pintar na branch master, o Travis CI vai rodar sua bateria de testes e, se tudo passar, seu site será publicado através do script publish-gh-pages.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Siga estes passos para configurar seu site Docusaurus no Netlify:
+
+
Select New site from Git
+
Conecte ao provedor Git de sua preferência.
+
Selecione a branch a ser publicada. A padrão é a master
+
Configure as etapas do processo de build:
+
+
Como comando de build, insira: cd website; npm install; npm run build;
+
Como diretório de publicação: website/build/<nomeDoProjeto> (use o nomeDoProjeto que está lá no seu siteConfig)
+
+
Click Deploy site
+
+
Você também pode configurar o Netlify para repetir esse processo a cada commit no seu repositório, ou apenas para commits na branch master.
+
Hosting on Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Selecione a branch a ser publicada. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
That's it! Your app will be live on your Render URL as soon as the build finishes.
+
Publicando no GitHub Enterprise
+
Publicar no GitHub Enterprise deve funcionar da mesma maneira que no GitHub.com; você só precisa identificar o host da organização no GitHub Enterprise.
+
+
+
Nome
Descrição
+
+
+
GITHUB_HOST
O nome do host para o servidor GitHub Enterprise.
+
+
+
Altere o seu siteConfig.js para adicionar uma propriedade 'githubHost', que representa o nome do host no GitHub Enterprise. Como alternativa, você pode definir uma variável de ambiente GITHUB_HOST ao executar o comando de publicação.
\ No newline at end of file
diff --git a/docs/pt-BR/publishing/index.html b/docs/pt-BR/publishing/index.html
new file mode 100644
index 0000000000..a9c78c4caa
--- /dev/null
+++ b/docs/pt-BR/publishing/index.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
Agora você já deve ter um site pronto rodando localmente. Assim que você tiver terminado de personalizar ele para ficar nos trinques, é hora de publicá-lo. O Docusaurus gera um site estático HTML prontinho para ser servido pelo seu servidor ou solução de hospedagem favorito.
+
Gerando páginas estáticas HTML
+
Para criar uma versão estática do seu site, execute o seguinte script no diretório website:
+
yarn run build # ou `npm run build`
+
+
Isso vai gerar um diretório build dentro do diretório website contendo os arquivos .html da sua documentação e de outras páginas incluídas em pages.
+
Hospedando páginas estáticas HTML
+
Neste ponto, você já pode pegar todos os arquivos dentro do diretório website/build e copiar eles diretamente para o diretório html do seu servidor web favorito.
+
+
For example, both Apache and Nginx serve content from /var/www/html by default. Com isso dito, escolher onde você vai hospedar seu site está fora do escopo do Docusaurus.
+
+
+
Ao servir o site a partir de seu próprio servidor web, certifique-se de que ele esteja servindo os arquivos de assets com os cabeçalhos HTTP adequados. Arquivos CSS devem ser servidos com o cabeçalho de content-type como 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.
Run a single command inside the root directory of your project:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Usando o GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
Mesmo que seu repositório seja privado, qualquer coisa publicada em uma branch gh-pages será pública.
+
+
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
Nome
Descrição
+
+
+
organizationName
O usuário ou organização que é dona do repositório. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "facebook" GitHub organization.
+
projectName
O nome do repositório do seu projeto no GitHub. 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
Por mais que recomendemos configurar o projectName e o organizationName no siteConfig.js, você também pode usar as variáveis de ambiente ORGANIZATION_NAME e PROJECT_NAME.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
Nome
Descrição
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your repositories, this will usually be your own GitHub username. O GIT_USER especificado precisa ter acesso de push no repositório especificado pela combinação de organizationName e projectName.
+
+
+
Para rodar o script diretamente da linha de comando, você pode usar o seguinte comando, preenchendo os valores de parâmetros conforme apropriado.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # ou `npm run publish-gh-pages`
+
Há também dois parâmetros opcionais que são definidos como variáveis de ambiente:
+
+
+
Nome
Descrição
+
+
+
USE_SSH
Se definida como true, a conexão ao repositório do GitHub será feita por meio de SSH, ao invés de HTTPS. HTTPS é o padrão se essa variável não for definida.
+
CURRENT_BRANCH
A branch que contém as alterações na documentação mais recentes que serão publicadas. Geralmente, essa branch será a master, mas poderia ser qualquer branch (padrão ou não) exceto pela gh-pages. Se nada for definido para essa variável, então a branch atual será usada.
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 cnamesiteConfig option.
+
Recomendamos fortemente que você leia a documentação do GitHub Pages para saber mais sobre como essa solução de hospedagem funciona.
+
Você pode executar o comando acima a qualquer momento que você atualizar sua documentação e desejar publicar as alterações no seu site. Executar o script manualmente pode funcionar bem para sites onde a documentação raramente muda e não seja muito inconveniente lembrar de publicar as alterações manualmente.
+
No entanto, você pode automatizar o processo de publicação com integração contínua (CI).
+
Automatizando deploys usando integração contínua
+
Serviços de integração contínua (CI) são normalmente usados para realizar tarefas de rotina sempre que novos commits são enviados para o controle de código fonte. Dentre essas tarefas estão a execução de testes unitários e de integração, a automatização de builds, a publicação de pacotes ao NPM e, sim, a implementação de alterações ao seu site. All you need to do to automate the 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.
+
Usando CircleCI 2.0
+
Se ainda não tiver o feito, você pode configurar o CircleCI para seu projeto de código aberto. Depois disso, para poder fazer o deploy automático do seu site e documentação via CircleCI, basta configurar o Circle para executar o script publish-gh-pages como parte do processo de deploy. Você pode seguir este passo-a-passo para configurar certinho:
+
+
Tenha certeza que a conta do GitHub que vai ser definida como GIT_USER tem acesso de escrita (write) ao repositório que contém a documentação. Você pode ver isso em Settings | Collaborators & teams no repositório.
+
Faça login no GitHub como o GIT_USER.
+
Vá para https://github.com/settings/tokens como o GIT_USER e gere um novo token de acesso pessoal, concedendo a ele controle total sobre repositórios privados através do escopo de acesso repository. Guarde este token em um lugar seguro, e tenha certeza de não compartilhar ele com ninguém. Este token pode ser usado para autenticar e realizar ações em seu nome, como se fosse a sua senha do GitHub.
+
Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". O URL é algo como https://circleci.com/gh/ORG/REPO/edit#env-vars, onde "ORG/REPO" deve ser substituído pela sua própria organização/repositório do seu GitHub.
+
Crie uma nova variável de ambiente chamada GITHUB_TOKEN, usando seu token de acesso recém-criado como o valor dela.
+
Crie um diretório .circleci e crie um arquivo config.yml dentro dele.
+
Copie o texto abaixo para o .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
Não se esqueça de substituir todos os <....> na sequência command: com os valores adequados. Como <GIT_USER>, você pode definir uma conta do GitHub que tenha permissão de push na documentação do seu repositório do GitHub. Na maioria das vezes, <GIT_USER> e <GITHUB_USERNAME> serão a mesma coisa.
+
DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 5.
+
+
Se você quiser usar SSH para a conexão com o seu repositório GitHub, você pode configurar USE_SSH=true. Dessa forma, o comando acima seria algo como: 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.
+
+
Agora, sempre que um novo commit pintar na branch master, o CircleCI vai rodar sua bateria de testes e, se tudo passar, seu site será publicado através do script publish-gh-pages.
+
+
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.
+
+
Truques e dicas
+
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 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"Pulando testes na branch gh-pages"
+
+
Salve este arquivo como config.yml e coloque-o em um diretório .circleci dentro do seu diretório website/static.
Abra seu painel do Travis CI. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
Crie uma nova variável de ambiente chamada GH_TOKEN com seu token recém-criado como seu valor. Depois, crie GH_EMAIL (seu endereço de e-mail) e GH_NAME (seu nome de usuário do GitHub).
+
Crie um .travis.yml na raiz do seu repositório contendo o texto abaixo.
Agora, sempre que um novo commit pintar na branch master, o Travis CI vai rodar sua bateria de testes e, se tudo passar, seu site será publicado através do script publish-gh-pages.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Siga estes passos para configurar seu site Docusaurus no Netlify:
+
+
Select New site from Git
+
Conecte ao provedor Git de sua preferência.
+
Selecione a branch a ser publicada. A padrão é a master
+
Configure as etapas do processo de build:
+
+
Como comando de build, insira: cd website; npm install; npm run build;
+
Como diretório de publicação: website/build/<nomeDoProjeto> (use o nomeDoProjeto que está lá no seu siteConfig)
+
+
Click Deploy site
+
+
Você também pode configurar o Netlify para repetir esse processo a cada commit no seu repositório, ou apenas para commits na branch master.
+
Hosting on Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Selecione a branch a ser publicada. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
That's it! Your app will be live on your Render URL as soon as the build finishes.
+
Publicando no GitHub Enterprise
+
Publicar no GitHub Enterprise deve funcionar da mesma maneira que no GitHub.com; você só precisa identificar o host da organização no GitHub Enterprise.
+
+
+
Nome
Descrição
+
+
+
GITHUB_HOST
O nome do host para o servidor GitHub Enterprise.
+
+
+
Altere o seu siteConfig.js para adicionar uma propriedade 'githubHost', que representa o nome do host no GitHub Enterprise. Como alternativa, você pode definir uma variável de ambiente GITHUB_HOST ao executar o comando de publicação.
\ No newline at end of file
diff --git a/docs/pt-BR/search.html b/docs/pt-BR/search.html
new file mode 100644
index 0000000000..08800abc0d
--- /dev/null
+++ b/docs/pt-BR/search.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
O Docusaurus oferece suporte a pesquisa usando o Algolia DocSearch. Assim que seu site estiver publicado, você poderá enviá-lo para o DocSearch. Em seguida, o Algolia vai te enviar credenciais que você pode adicionar ao seu siteConfig.js.
+
Funciona assim: o DocSearch vasculha o conteúdo do seu site a cada 24 horas e coloca tudo que ele encontrou em um índice de pesquisa do Algolia. Esse conteúdo poderá então ser consultado diretamente do seu front-end usando a API do Algolia. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). Este serviço é gratuito.
+
Ativando a barra de pesquisa
+
Para ativar a pesquisa no seu site, basta salvar a sua chave de API e o nome do seu índice (enviados pelo Algolia) no siteConfig.js, na seção algolia.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Opções adicionais de pesquisa
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Isso pode ser útil caso você queira fornecer resultados de busca diferentes para as diferentes versões e idiomas da sua documentação. Todas as ocorrências de "VERSION" ou "LANGUAGE" serão substituídas pela versão ou idioma da página atual, respectivamente. Mais detalhes sobre as opções de pesquisa podem ser encontrados aqui.
Algolia might provide you with extra search options. Se fornecer, você deve adicioná-las ao objeto algoliaOptions.
+
Controlando o local da barra de pesquisa
+
Por padrão, a barra de pesquisa será o elemento mais à direita no menu de navegação superior.
+
Se você quiser mudar o local padrão, adicione a flag searchBar no campo headerLinks do siteConfig.js, na posição de sua preferência. Por exemplo, você pode querer que a barra de pesquisa fique entre seus links internos e externos.
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:
\ No newline at end of file
diff --git a/docs/pt-BR/search/index.html b/docs/pt-BR/search/index.html
new file mode 100644
index 0000000000..08800abc0d
--- /dev/null
+++ b/docs/pt-BR/search/index.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
O Docusaurus oferece suporte a pesquisa usando o Algolia DocSearch. Assim que seu site estiver publicado, você poderá enviá-lo para o DocSearch. Em seguida, o Algolia vai te enviar credenciais que você pode adicionar ao seu siteConfig.js.
+
Funciona assim: o DocSearch vasculha o conteúdo do seu site a cada 24 horas e coloca tudo que ele encontrou em um índice de pesquisa do Algolia. Esse conteúdo poderá então ser consultado diretamente do seu front-end usando a API do Algolia. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). Este serviço é gratuito.
+
Ativando a barra de pesquisa
+
Para ativar a pesquisa no seu site, basta salvar a sua chave de API e o nome do seu índice (enviados pelo Algolia) no siteConfig.js, na seção algolia.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Opções adicionais de pesquisa
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Isso pode ser útil caso você queira fornecer resultados de busca diferentes para as diferentes versões e idiomas da sua documentação. Todas as ocorrências de "VERSION" ou "LANGUAGE" serão substituídas pela versão ou idioma da página atual, respectivamente. Mais detalhes sobre as opções de pesquisa podem ser encontrados aqui.
Algolia might provide you with extra search options. Se fornecer, você deve adicioná-las ao objeto algoliaOptions.
+
Controlando o local da barra de pesquisa
+
Por padrão, a barra de pesquisa será o elemento mais à direita no menu de navegação superior.
+
Se você quiser mudar o local padrão, adicione a flag searchBar no campo headerLinks do siteConfig.js, na posição de sua preferência. Por exemplo, você pode querer que a barra de pesquisa fique entre seus links internos e externos.
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:
\ No newline at end of file
diff --git a/docs/pt-BR/site-config.html b/docs/pt-BR/site-config.html
new file mode 100644
index 0000000000..293ede8453
--- /dev/null
+++ b/docs/pt-BR/site-config.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
Grande parte da configuração do site é feita a partir da edição do arquivo siteConfig.js.
+
Vitrine de usuários
+
O array users é usado para armazenar objetos para cada projeto/usuário que você queira mostrar no seu site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Cada objeto de usuário deve ter os campos caption, image, infoLink e pinned. caption é o texto mostrado quando alguém passa o ponteiro do mouse por cima da imagem (image) daquele usuário, e o campo infoLink é para onde as pessoas serão levadas ao clicar na imagem. O campo pinned determina se a imagem aparecerá ou não na página index.
+
Atualmente, este array users é usado apenas pelos arquivos de exemplo index.js e users.js. Caso não deseje ter uma página de usuários nem mostrar usuários na página index, você pode remover esta seção.
+
Campos do siteConfig
+
O objeto siteConfig contém a maioria dos ajustes de configuração do seu site.
+
Campos obrigatórios
+
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/. Para URLs que não têm caminho, o baseUrl deve ser definido para /. This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor é a cor usada no menu superior de navegação e nas barras laterais.
+
secondaryColor é a cor vista na segunda linha do menu de navegação quando a janela do site estiver estreita (incluindo na versão móvel).
+
Cores personalizadas também podem ser configuradas. Por exemplo, se o estilo que o usuário estiver adicionando com as cores especificadas em $myColor, então adicionar o campo myColor para colors, permitirá que você configure esta cor.
+
+
copyright [string]
+
A string de direitos autorais no rodapé do site e dentro do feed
+
favicon [string]
+
URL for site favicon.
+
headerIcon [string]
+
URL usada na barra de navegação do cabeçalho.
+
headerLinks [array]
+
Links que serão utilizados na barra de navegação do cabeçalho. O campo label de cada objeto será o texto do link e também será traduzido para cada idioma.
+
Exemplo de uso:
+
headerLinks: [
+ // Links para documentos com id doc1 para o idioma/versão atual
+ { doc: "doc1", etiqueta: "Getting Started" },
+ // Link para a página encontrada em páginas/en/help. s ou se isso não existir, páginas/ajuda. s, for current language
+ { page: "help", label: "Help" },
+ // Links para destino href, usando target=_blank (external)
+ { href: "https://github. om/", etiqueta: "GitHub", externo: verdadeiro },
+ // Links para o blog gerado pelo Docusaurus (${baseUrl}blog)
+ { blog: true, label: "Blog" },
+ // Determina a posição da barra de pesquisa entre os links
+ { search: true },
+ // Determina a posição de seleção do idioma entre os 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]
+
Nome do projeto. Isso deve corresponder ao nome do projeto do seu repositório GitHub (diferencia maiúsculas de minúsculas).
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 - o Algolia forneceu uma chave de API para a sua pesquisa.
+
indexName - o nome de índice fornecido pelo Algolia para a sua pesquisa (que geralmente é o nome do projeto).
+
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.
Se os usuários pretendem que este site seja usado exclusivamente offline, este valor deve ser definido para false. Caso contrário, ele fará com que o site siga para a pasta pai da página vinculada.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
docsUrl [string]
+
A URL base para todos os arquivos de documentação. 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.
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.
{
+ // ...
+ 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.
+
opcoesMarkdown [object]
+
Override default Remarkable options that will be used to render markdown.
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:
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). Esta imagem será exibida quando seu site for compartilhado no Facebook e outros sites/apps onde o protocolo Open Graph é suportado.
+
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:
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.
+
separarCss [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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adicionando Google Fonts
+
+
Google Fonts oferece tempos de carga mais rápidos, cache de fontes sem forçar os usuários a sacrificar a privacidade. Para obter mais informações sobre o Google Fonts, consulte a documentação Google Fonts.
+
Para adicionar Google Fonts à sua implantação do Docusaurus, adicione o caminho de fonte para siteConfig.js sob stylesheets:
\ No newline at end of file
diff --git a/docs/pt-BR/site-config/index.html b/docs/pt-BR/site-config/index.html
new file mode 100644
index 0000000000..293ede8453
--- /dev/null
+++ b/docs/pt-BR/site-config/index.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
Grande parte da configuração do site é feita a partir da edição do arquivo siteConfig.js.
+
Vitrine de usuários
+
O array users é usado para armazenar objetos para cada projeto/usuário que você queira mostrar no seu site. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Cada objeto de usuário deve ter os campos caption, image, infoLink e pinned. caption é o texto mostrado quando alguém passa o ponteiro do mouse por cima da imagem (image) daquele usuário, e o campo infoLink é para onde as pessoas serão levadas ao clicar na imagem. O campo pinned determina se a imagem aparecerá ou não na página index.
+
Atualmente, este array users é usado apenas pelos arquivos de exemplo index.js e users.js. Caso não deseje ter uma página de usuários nem mostrar usuários na página index, você pode remover esta seção.
+
Campos do siteConfig
+
O objeto siteConfig contém a maioria dos ajustes de configuração do seu site.
+
Campos obrigatórios
+
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/. Para URLs que não têm caminho, o baseUrl deve ser definido para /. This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor é a cor usada no menu superior de navegação e nas barras laterais.
+
secondaryColor é a cor vista na segunda linha do menu de navegação quando a janela do site estiver estreita (incluindo na versão móvel).
+
Cores personalizadas também podem ser configuradas. Por exemplo, se o estilo que o usuário estiver adicionando com as cores especificadas em $myColor, então adicionar o campo myColor para colors, permitirá que você configure esta cor.
+
+
copyright [string]
+
A string de direitos autorais no rodapé do site e dentro do feed
+
favicon [string]
+
URL for site favicon.
+
headerIcon [string]
+
URL usada na barra de navegação do cabeçalho.
+
headerLinks [array]
+
Links que serão utilizados na barra de navegação do cabeçalho. O campo label de cada objeto será o texto do link e também será traduzido para cada idioma.
+
Exemplo de uso:
+
headerLinks: [
+ // Links para documentos com id doc1 para o idioma/versão atual
+ { doc: "doc1", etiqueta: "Getting Started" },
+ // Link para a página encontrada em páginas/en/help. s ou se isso não existir, páginas/ajuda. s, for current language
+ { page: "help", label: "Help" },
+ // Links para destino href, usando target=_blank (external)
+ { href: "https://github. om/", etiqueta: "GitHub", externo: verdadeiro },
+ // Links para o blog gerado pelo Docusaurus (${baseUrl}blog)
+ { blog: true, label: "Blog" },
+ // Determina a posição da barra de pesquisa entre os links
+ { search: true },
+ // Determina a posição de seleção do idioma entre os 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]
+
Nome do projeto. Isso deve corresponder ao nome do projeto do seu repositório GitHub (diferencia maiúsculas de minúsculas).
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 - o Algolia forneceu uma chave de API para a sua pesquisa.
+
indexName - o nome de índice fornecido pelo Algolia para a sua pesquisa (que geralmente é o nome do projeto).
+
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.
Se os usuários pretendem que este site seja usado exclusivamente offline, este valor deve ser definido para false. Caso contrário, ele fará com que o site siga para a pasta pai da página vinculada.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
docsUrl [string]
+
A URL base para todos os arquivos de documentação. 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.
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.
{
+ // ...
+ 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.
+
opcoesMarkdown [object]
+
Override default Remarkable options that will be used to render markdown.
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:
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). Esta imagem será exibida quando seu site for compartilhado no Facebook e outros sites/apps onde o protocolo Open Graph é suportado.
+
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:
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.
+
separarCss [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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adicionando Google Fonts
+
+
Google Fonts oferece tempos de carga mais rápidos, cache de fontes sem forçar os usuários a sacrificar a privacidade. Para obter mais informações sobre o Google Fonts, consulte a documentação Google Fonts.
+
Para adicionar Google Fonts à sua implantação do Docusaurus, adicione o caminho de fonte para siteConfig.js sob stylesheets:
\ No newline at end of file
diff --git a/docs/pt-BR/tutorial-create-pages.html b/docs/pt-BR/tutorial-create-pages.html
new file mode 100644
index 0000000000..ce5f8dc0cb
--- /dev/null
+++ b/docs/pt-BR/tutorial-create-pages.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/pt-BR/tutorial-create-pages/index.html b/docs/pt-BR/tutorial-create-pages/index.html
new file mode 100644
index 0000000000..ce5f8dc0cb
--- /dev/null
+++ b/docs/pt-BR/tutorial-create-pages/index.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/pt-BR/tutorial-version.html b/docs/pt-BR/tutorial-version.html
new file mode 100644
index 0000000000..51fa1172b0
--- /dev/null
+++ b/docs/pt-BR/tutorial-version.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ No newline at end of file
diff --git a/docs/pt-BR/tutorial-version/index.html b/docs/pt-BR/tutorial-version/index.html
new file mode 100644
index 0000000000..51fa1172b0
--- /dev/null
+++ b/docs/pt-BR/tutorial-version/index.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ 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..2cc972b41c
--- /dev/null
+++ b/docs/ro/adding-blog.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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:
Will be available at https://website/blog/introducing-docusaurus
+
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.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
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:
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'.
Docusaurus provides an 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 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 twittersite 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:
+
+
Create a file index.html in website/static/.
+
Place the contents of the template below into website/static/index.html
+
Customize the <title> of website/static/index.html
+
Delete the dynamic landing page website/pages/en/index.js
+
+
+
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>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ 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..2cc972b41c
--- /dev/null
+++ b/docs/ro/adding-blog/index.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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:
Will be available at https://website/blog/introducing-docusaurus
+
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.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
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:
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'.
Docusaurus provides an 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 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 twittersite 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:
+
+
Create a file index.html in website/static/.
+
Place the contents of the template below into website/static/index.html
+
Customize the <title> of website/static/index.html
+
Delete the dynamic landing page website/pages/en/index.js
+
+
+
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>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/ro/docker.html b/docs/ro/docker.html
new file mode 100644
index 0000000000..5834726a7e
--- /dev/null
+++ b/docs/ro/docker.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
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.
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.
+
+
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 .
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
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:
+
+
Define your app’s environment with a Dockerfile so it can be reproduced anywhere.
+
Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.
+
Run docker-compose up and Compose starts and runs your entire app.
+
+
We include a basic docker-compose.yml in your project:
\ 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..5834726a7e
--- /dev/null
+++ b/docs/ro/docker/index.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
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.
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.
+
+
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 .
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
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:
+
+
Define your app’s environment with a Dockerfile so it can be reproduced anywhere.
+
Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.
+
Run docker-compose up and Compose starts and runs your entire app.
+
+
We include a basic docker-compose.yml in your project:
\ No newline at end of file
diff --git a/docs/ro/installation.html b/docs/ro/installation.html
new file mode 100644
index 0000000000..095dd2e5d3
--- /dev/null
+++ b/docs/ro/installation.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Installing Docusaurus
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
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.
+
+
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.
+
+
+
Verificând instalarea
+
Along with previously existing files and directories, your root directory will now contain a structure similar to:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
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:
+
+
siteweb cd
+
From within the website directory, run the local web server using yarn start or npm start.
+
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.
+
+
+
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 versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
If there is no noticeable version output from the outdated commands, then you are up-to-date.
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.
\ 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..095dd2e5d3
--- /dev/null
+++ b/docs/ro/installation/index.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Installing Docusaurus
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
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.
+
+
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.
+
+
+
Verificând instalarea
+
Along with previously existing files and directories, your root directory will now contain a structure similar to:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
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:
+
+
siteweb cd
+
From within the website directory, run the local web server using yarn start or npm start.
+
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.
+
+
+
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 versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
If there is no noticeable version output from the outdated commands, then you are up-to-date.
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.
\ No newline at end of file
diff --git a/docs/ro/publishing.html b/docs/ro/publishing.html
new file mode 100644
index 0000000000..43d3b4713e
--- /dev/null
+++ b/docs/ro/publishing.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
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.
Run a single command inside the root directory of your project:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Using GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
Name
Description
+
+
+
organizationName
The 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.
+
projectName
The 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
Name
Description
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your 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.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
There are also two optional parameters that are set as environment variables:
+
+
+
Name
Description
+
+
+
USE_SSH
If 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_BRANCH
The 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.
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 cnamesiteConfig 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 the 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.
+
+
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.
+
Log into GitHub as the GIT_USER.
+
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.
+
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.
+
Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
+
Create a .circleci directory and create a config.yml under that directory.
+
Copy the text below into .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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 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 your GitHub account, add the Travis CI app to the repository you want to activate.
+
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.
+
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).
+
Create a .travis.yml on the root of your repository with below text.
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.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Steps to configure your Docusaurus-powered site on Netlify.
+
+
Select New site from Git
+
Connect to your preferred Git provider.
+
Select the branch to deploy. Default is master
+
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)
+
+
Click Deploy site
+
+
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 deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Select the branch to deploy. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
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.
+
+
+
Name
Description
+
+
+
GITHUB_HOST
The hostname for the GitHub enterprise server.
+
+
+
Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.
\ No newline at end of file
diff --git a/docs/ro/publishing/index.html b/docs/ro/publishing/index.html
new file mode 100644
index 0000000000..43d3b4713e
--- /dev/null
+++ b/docs/ro/publishing/index.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
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.
Run a single command inside the root directory of your project:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Using GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
Name
Description
+
+
+
organizationName
The 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.
+
projectName
The 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
Name
Description
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your 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.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
There are also two optional parameters that are set as environment variables:
+
+
+
Name
Description
+
+
+
USE_SSH
If 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_BRANCH
The 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.
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 cnamesiteConfig 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 the 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.
+
+
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.
+
Log into GitHub as the GIT_USER.
+
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.
+
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.
+
Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
+
Create a .circleci directory and create a config.yml under that directory.
+
Copy the text below into .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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 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 your GitHub account, add the Travis CI app to the repository you want to activate.
+
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.
+
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).
+
Create a .travis.yml on the root of your repository with below text.
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.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Steps to configure your Docusaurus-powered site on Netlify.
+
+
Select New site from Git
+
Connect to your preferred Git provider.
+
Select the branch to deploy. Default is master
+
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)
+
+
Click Deploy site
+
+
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 deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Select the branch to deploy. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
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.
+
+
+
Name
Description
+
+
+
GITHUB_HOST
The hostname for the GitHub enterprise server.
+
+
+
Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.
\ No newline at end of file
diff --git a/docs/ro/search.html b/docs/ro/search.html
new file mode 100644
index 0000000000..434dbf6466
--- /dev/null
+++ b/docs/ro/search.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
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',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ 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.
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.
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:
\ 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..434dbf6466
--- /dev/null
+++ b/docs/ro/search/index.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
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',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ 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.
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.
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:
\ 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..66e43e846a
--- /dev/null
+++ b/docs/ro/site-config.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
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 the example 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. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
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, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ 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..66e43e846a
--- /dev/null
+++ b/docs/ro/site-config/index.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
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 the example 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. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
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, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ 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..4104ce3309
--- /dev/null
+++ b/docs/ro/tutorial-create-pages.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ 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..4104ce3309
--- /dev/null
+++ b/docs/ro/tutorial-create-pages/index.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ 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..6c5642a68d
--- /dev/null
+++ b/docs/ro/tutorial-version.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ 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..6c5642a68d
--- /dev/null
+++ b/docs/ro/tutorial-version/index.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ No newline at end of file
diff --git a/docs/ru/adding-blog.html b/docs/ru/adding-blog.html
new file mode 100644
index 0000000000..78cffd9eb6
--- /dev/null
+++ b/docs/ru/adding-blog.html
@@ -0,0 +1,219 @@
+Adding a Blog · Docusaurus
Чтобы добавить сообщение в блог, создайте в своем каталоге blog файл с именем следующего вида: YYYY-MM-DD-my-blog-post-title.md. Дата добавления сообщения будет извлечена из этого имени.
+
Например, website/blog/2017-12-14-introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
Настройки заголовка
+
Единственное обязательное поле это title; однако мы также предоставляем возможность добавить в сообщение информацию об авторе.
+
+
author - Текстовое обозначение автора, имя.
+
authorURL - URL-адрес, связанный с автором. Это может быть ссылка на учетную запись Twiter, Github, Facebook или что-либо еще.
+
authorFBID - Идентификатор профиля Facebook, который используется для получения изображения-аватара.
+
authorImageURL - URL-адрес к изображению-аватару автора. (Примечание: Если вы используете вместе authorFBID и authorImageURL, то authorFBID будет иметь приоритет. Не указывайте поле authorFBID, если желаете использовать изображение по адресу, указанному в authorImageURL.)
+
title - Заголовок сообщения блога.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
unlisted - Сообщение будет доступно по прямому URL-адресу, но не будет отображено в боковой панели в конечной сборке; при локальной же разработке сообщение будет отображено. Полезно в ситуациях, когда вам нужно поделиться WIP сообщением с другими людьми для получения их оценки.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
Обрезка резюме
+
Используйте маркер <!--truncate--> в своем сообщении для указания того, какая часть этого сообщения будет отображена в его резюме. Все, что размещено до <!--truncate-->, станет частью резюме. Например:
Определение количества сообщений блога, отображаемых в боковой панели
+
По-умолчанию, в боковой панели отображаются 5 последних сообщений блога.
+
Вы можете настроить количество отображаемых сообщений, добавив поле blogSidebarCount в файл siteConfig.js.
+
Допустимые значения - целое число, определяющее количество сообщений, которые вы хотите показать, или строка со значением 'ALL'.
+
Например:
+
blogSidebarCount: 'ALL',
+
+
Определение заголовка боковой панели
+
Вы можете указать заголовок для боковой панели, добавив поле blogSidebarTitle в siteConfig.js.
+
Это поле представляет собой объект, который может содержать свойства default и all. Указав значение для свойства default вы можете изменить заголовок боковой панели по-умолчанию. Указав значение для all, вы можете изменить заголовок боковой панели, когда значение поля blogSidebarCount равно 'ALL'.
Docusaurus provides an RSS feed for your blog posts. Поддерживаются оба формата - RSS и Atom. Эти данные будут автоматически добавлены в секцию <HEAD> HTML страниц вашего сайта.
+
Краткий текст сообщения до тега <!--truncate--> отправляется в RSS-канал. If no <!--truncate--> tag is found, then all text up to 250 characters are used.
+
Социальные Кнопки
+
Если вы желаете добавить кнопки социальных сетей Facebook или Twitter в нижнюю часть сообщений своего блога, установите параметр facebookAppId и/или twitter в настройках сайта в siteConfig.js.
+
Дополнительные возможности
+
Я хочу работать в режиме «Только блог».
+
Вы можете запустить свой сайт на Docusaurus, на котором вместо обычной посадочной страницы в качестве главной будет использоваться страница вашего блога.
+
Для этого:
+
+
Создайте файл index.html в website/static/.
+
Перенесите содержимое шаблона ниже в website/static/index.html
Теперь, когда Docusaurus будет генерировать или строить ваш сайт, он скопирует файл static/index.html и разместит его в главном каталоге вашего сайта. Статический файл будет отдан посетителю, когда он придет на страницу. Когда страница загрузится, посетитель будет перенаправлен на /blog.
+
+
Вы можете использовать этот шаблон:
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/ru/adding-blog/index.html b/docs/ru/adding-blog/index.html
new file mode 100644
index 0000000000..78cffd9eb6
--- /dev/null
+++ b/docs/ru/adding-blog/index.html
@@ -0,0 +1,219 @@
+Adding a Blog · Docusaurus
Чтобы добавить сообщение в блог, создайте в своем каталоге blog файл с именем следующего вида: YYYY-MM-DD-my-blog-post-title.md. Дата добавления сообщения будет извлечена из этого имени.
+
Например, website/blog/2017-12-14-introducing-docusaurus.md:
Will be available at https://website/blog/introducing-docusaurus
+
Настройки заголовка
+
Единственное обязательное поле это title; однако мы также предоставляем возможность добавить в сообщение информацию об авторе.
+
+
author - Текстовое обозначение автора, имя.
+
authorURL - URL-адрес, связанный с автором. Это может быть ссылка на учетную запись Twiter, Github, Facebook или что-либо еще.
+
authorFBID - Идентификатор профиля Facebook, который используется для получения изображения-аватара.
+
authorImageURL - URL-адрес к изображению-аватару автора. (Примечание: Если вы используете вместе authorFBID и authorImageURL, то authorFBID будет иметь приоритет. Не указывайте поле authorFBID, если желаете использовать изображение по адресу, указанному в authorImageURL.)
+
title - Заголовок сообщения блога.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
unlisted - Сообщение будет доступно по прямому URL-адресу, но не будет отображено в боковой панели в конечной сборке; при локальной же разработке сообщение будет отображено. Полезно в ситуациях, когда вам нужно поделиться WIP сообщением с другими людьми для получения их оценки.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
Обрезка резюме
+
Используйте маркер <!--truncate--> в своем сообщении для указания того, какая часть этого сообщения будет отображена в его резюме. Все, что размещено до <!--truncate-->, станет частью резюме. Например:
Определение количества сообщений блога, отображаемых в боковой панели
+
По-умолчанию, в боковой панели отображаются 5 последних сообщений блога.
+
Вы можете настроить количество отображаемых сообщений, добавив поле blogSidebarCount в файл siteConfig.js.
+
Допустимые значения - целое число, определяющее количество сообщений, которые вы хотите показать, или строка со значением 'ALL'.
+
Например:
+
blogSidebarCount: 'ALL',
+
+
Определение заголовка боковой панели
+
Вы можете указать заголовок для боковой панели, добавив поле blogSidebarTitle в siteConfig.js.
+
Это поле представляет собой объект, который может содержать свойства default и all. Указав значение для свойства default вы можете изменить заголовок боковой панели по-умолчанию. Указав значение для all, вы можете изменить заголовок боковой панели, когда значение поля blogSidebarCount равно 'ALL'.
Docusaurus provides an RSS feed for your blog posts. Поддерживаются оба формата - RSS и Atom. Эти данные будут автоматически добавлены в секцию <HEAD> HTML страниц вашего сайта.
+
Краткий текст сообщения до тега <!--truncate--> отправляется в RSS-канал. If no <!--truncate--> tag is found, then all text up to 250 characters are used.
+
Социальные Кнопки
+
Если вы желаете добавить кнопки социальных сетей Facebook или Twitter в нижнюю часть сообщений своего блога, установите параметр facebookAppId и/или twitter в настройках сайта в siteConfig.js.
+
Дополнительные возможности
+
Я хочу работать в режиме «Только блог».
+
Вы можете запустить свой сайт на Docusaurus, на котором вместо обычной посадочной страницы в качестве главной будет использоваться страница вашего блога.
+
Для этого:
+
+
Создайте файл index.html в website/static/.
+
Перенесите содержимое шаблона ниже в website/static/index.html
Теперь, когда Docusaurus будет генерировать или строить ваш сайт, он скопирует файл static/index.html и разместит его в главном каталоге вашего сайта. Статический файл будет отдан посетителю, когда он придет на страницу. Когда страница загрузится, посетитель будет перенаправлен на /blog.
+
+
Вы можете использовать этот шаблон:
+
<!DOCTYPE html>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/ru/docker.html b/docs/ru/docker.html
new file mode 100644
index 0000000000..5a25fc5f10
--- /dev/null
+++ b/docs/ru/docker.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
Docker это инструмент, позволяющий вам создавать, развертывать и управлять легковесными, самостоятельными пакетами, которые содержат все необходимое для запуска приложения. Он помогает избегать конфликта зависимостей и нежелательного поведения при запуске Docusaurus.
Build the docker image -- Enter the folder where you have Docusaurus installed. Выполните в терминале docker build -t docusaurus-doc .
+
Когда снимок будет создан, вы может проверить, что он существует, выполнив docker images.
+
+
Dockerfile будет добавлен в каталог проекта при установке Docusaurus.
+
+
Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc
+
В результате docker создаст и запустит контейнер на основе снимка docusaurus-doc. Чтобы увидеть подробную информацию о контейнере, выполните в терминале docker ps.
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
Использование docker-compose
+
Также для настройки приложения можно использовать docker-compose. Данная особенность docker позволяет запускать веб-сервер и дополнительные сервисы с помощью единственной команды.
+
+
Compose это инструмент для определения и запуска приложения Docker, состоящего из множества контейнеров. Вместе с Compose вы используете YAML файл для настройки сервисов вашего приложения. Затем, с помощью единственной команды, вы создаете и запускаете все сервисы из вашей конфигурации.
+
+
Использование Compose происходит в три шага:
+
+
Определите окружение вашего приложения с помощью Dockerfile, после чего оно может быть воспроизведено где угодно.
+
Определите сервисы, которые будут включены в ваше приложение в файле docker-compose.yml, после чего они могут быть запущены вместе в изолированном окружении.
+
Выполните docker-compose up, чтобы Compose запустил целиком ваше приложение.
+
+
Мы добавляем файл docker-compose.yml с минимальными настройками в ваш проект:
\ No newline at end of file
diff --git a/docs/ru/docker/index.html b/docs/ru/docker/index.html
new file mode 100644
index 0000000000..5a25fc5f10
--- /dev/null
+++ b/docs/ru/docker/index.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
Docker это инструмент, позволяющий вам создавать, развертывать и управлять легковесными, самостоятельными пакетами, которые содержат все необходимое для запуска приложения. Он помогает избегать конфликта зависимостей и нежелательного поведения при запуске Docusaurus.
Build the docker image -- Enter the folder where you have Docusaurus installed. Выполните в терминале docker build -t docusaurus-doc .
+
Когда снимок будет создан, вы может проверить, что он существует, выполнив docker images.
+
+
Dockerfile будет добавлен в каталог проекта при установке Docusaurus.
+
+
Run the Docusaurus container -- To start docker run docker run --rm -p 3000:3000 docusaurus-doc
+
В результате docker создаст и запустит контейнер на основе снимка docusaurus-doc. Чтобы увидеть подробную информацию о контейнере, выполните в терминале docker ps.
+
+
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
Использование docker-compose
+
Также для настройки приложения можно использовать docker-compose. Данная особенность docker позволяет запускать веб-сервер и дополнительные сервисы с помощью единственной команды.
+
+
Compose это инструмент для определения и запуска приложения Docker, состоящего из множества контейнеров. Вместе с Compose вы используете YAML файл для настройки сервисов вашего приложения. Затем, с помощью единственной команды, вы создаете и запускаете все сервисы из вашей конфигурации.
+
+
Использование Compose происходит в три шага:
+
+
Определите окружение вашего приложения с помощью Dockerfile, после чего оно может быть воспроизведено где угодно.
+
Определите сервисы, которые будут включены в ваше приложение в файле docker-compose.yml, после чего они могут быть запущены вместе в изолированном окружении.
+
Выполните docker-compose up, чтобы Compose запустил целиком ваше приложение.
+
+
Мы добавляем файл docker-compose.yml с минимальными настройками в ваш проект:
\ No newline at end of file
diff --git a/docs/ru/installation.html b/docs/ru/installation.html
new file mode 100644
index 0000000000..451d95d015
--- /dev/null
+++ b/docs/ru/installation.html
@@ -0,0 +1,203 @@
+Installation · Docusaurus
Docusaurus был разработан с нуля с целью быть легким в установке и использовании для создания и быстрого запуска вашего веб-сайта.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Установка Docusaurus
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
Убедитесь, что последняя версия Node уже установлена. Также мы рекомендуем установить Yarn.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Создайте проект, если он еще не существует, и перейдите в его корневой каталог.
+
В этом каталоге вами будут созданы документы. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and website.
+
+
Обычно, в качестве места расположения вашего сайта на Docusaurus будет использован либо существующий, либо вновь созданный проект GitHub, но это не единственный способ использования Docusaurus.
+
+
Запустите команду установки Docusaurus: npx docusaurus-init.
+
+
Если у вас не установлен Node 8.2+ или вы желаете установить Docusaurus глобально, выполните yarn global add docusaurus-init или npm install --global docusaurus-init. После этого выполните docusaurus-init.
+
+
+
Проверка установки
+
Наряду с уже существующими файлами и каталогами, корневой каталог теперь будет содержать структуру, похожую на:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
Запуск веб-сайта
+
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. Для этого:
+
+
cd website
+
From within the website directory, run the local web server using yarn start or npm start.
+
Load the example site at http://localhost:3000 if it did not already open automatically. Если порт 3000 уже занят, то будет использован другой порт. Проверьте сообщения в консоли, чтобы увидеть который именно.
+
Вы должны увидеть главную страницу запущенного примера веб-сайта. Также вы можете запустить LiveReload сервер, чтобы любые изменения в документах и файлах в каталоге website приводили к обновлению страницы. Для вашего сайта будут выбраны случайным образом основном и второстепенный цвета.
+
+
+
Использование прокси
+
Если вы используете корпоративный прокси-сервер, вам необходимо отключить его для разработки запросов к серверу. Для этого установите перменную окружения NO_PROXY.
+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+
Обновление вашей версии Docusaurus
+
В любое время после установки Docusaurus вы можете проверить его текущую версию, если перейдете в каталог website и наберете в терминале yarn outdated docusaurus или npm outdated docusaurus.
+
Вы увидите нечто вроде этого:
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
Если не были выведены какие-либо значимые данные о версии после выполнения команды outdated, значит версия самая свежая.
+
+
Вы можете обновить Docusaurus до последней версии, выполнив в терминале:
+
yarn upgrade docusaurus --latest
+
+
или
+
npm update docusaurus
+
+
+
Если после обновления вы получаете ошибки, попробуйте очистить ваш кэш Babel (обычно он расположен во временном каталоге) или запустите сервер Docusaurus (например, yarn start) с параметром окружения BABEL_DISABLE_CACHE=1.
\ No newline at end of file
diff --git a/docs/ru/installation/index.html b/docs/ru/installation/index.html
new file mode 100644
index 0000000000..451d95d015
--- /dev/null
+++ b/docs/ru/installation/index.html
@@ -0,0 +1,203 @@
+Installation · Docusaurus
Docusaurus был разработан с нуля с целью быть легким в установке и использовании для создания и быстрого запуска вашего веб-сайта.
+
+
Important Note: we highly encourage you to use Docusaurus 2 instead.
+
+
Установка Docusaurus
+
We have created a helpful script that will get all of the infrastructure set up for you:
+
+
Убедитесь, что последняя версия Node уже установлена. Также мы рекомендуем установить Yarn.
+
+
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
+
+
Создайте проект, если он еще не существует, и перейдите в его корневой каталог.
+
В этом каталоге вами будут созданы документы. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and website.
+
+
Обычно, в качестве места расположения вашего сайта на Docusaurus будет использован либо существующий, либо вновь созданный проект GitHub, но это не единственный способ использования Docusaurus.
+
+
Запустите команду установки Docusaurus: npx docusaurus-init.
+
+
Если у вас не установлен Node 8.2+ или вы желаете установить Docusaurus глобально, выполните yarn global add docusaurus-init или npm install --global docusaurus-init. После этого выполните docusaurus-init.
+
+
+
Проверка установки
+
Наряду с уже существующими файлами и каталогами, корневой каталог теперь будет содержать структуру, похожую на:
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
+
+
Запуск веб-сайта
+
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. Для этого:
+
+
cd website
+
From within the website directory, run the local web server using yarn start or npm start.
+
Load the example site at http://localhost:3000 if it did not already open automatically. Если порт 3000 уже занят, то будет использован другой порт. Проверьте сообщения в консоли, чтобы увидеть который именно.
+
Вы должны увидеть главную страницу запущенного примера веб-сайта. Также вы можете запустить LiveReload сервер, чтобы любые изменения в документах и файлах в каталоге website приводили к обновлению страницы. Для вашего сайта будут выбраны случайным образом основном и второстепенный цвета.
+
+
+
Использование прокси
+
Если вы используете корпоративный прокси-сервер, вам необходимо отключить его для разработки запросов к серверу. Для этого установите перменную окружения NO_PROXY.
+
SET NO_PROXY=localhost
+yarn start (or npm run start)
+
+
Обновление вашей версии Docusaurus
+
В любое время после установки Docusaurus вы можете проверить его текущую версию, если перейдете в каталог website и наберете в терминале yarn outdated docusaurus или npm outdated docusaurus.
+
Вы увидите нечто вроде этого:
+
$ yarn outdated
+Using globally installed versionof Yarn
+yarn outdated v1.5.1
+warning package.json: No license field
+warningNo 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.91.2.01.2.0 devDependencies https://github.com/facebook/docusaurus#readme
+✨ Done in0.41s.
+
+
+
Если не были выведены какие-либо значимые данные о версии после выполнения команды outdated, значит версия самая свежая.
+
+
Вы можете обновить Docusaurus до последней версии, выполнив в терминале:
+
yarn upgrade docusaurus --latest
+
+
или
+
npm update docusaurus
+
+
+
Если после обновления вы получаете ошибки, попробуйте очистить ваш кэш Babel (обычно он расположен во временном каталоге) или запустите сервер Docusaurus (например, yarn start) с параметром окружения BABEL_DISABLE_CACHE=1.
\ No newline at end of file
diff --git a/docs/ru/publishing.html b/docs/ru/publishing.html
new file mode 100644
index 0000000000..9672fcd9f1
--- /dev/null
+++ b/docs/ru/publishing.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
Теперь у вас должен быть настроенный и запущенный локально сайт. Как только вы настроили его по своему вкусу, настало время опубликовать его. Docusaurus создает статический HTML веб-сайт, готовый к запуску на на вашем любимом веб-сервере или через онлайн хостинг.
+
Создание статических HTML страниц
+
Чтобы создать статическую сборку своего веб-сайта, запустите следующую команду из каталога website:
+
yarn run build # или `npm run build`
+
+
В результате будет создан каталог build внутри каталога website, содержащий файлы .html для всех документов и других страниц, размещенных в pages.
+
Хостинг статических HTML страниц
+
На этом этапе вы можете взять все файлы из каталога website/build и скопировать их в каталог html на вашем любимом веб-сервере.
+
+
Например, Apache и Nginx обслуживают содержимое каталога /var/www/html по-умолчанию. Впрочем, выбор веб-сервера или провайдера выходит за рамки Docusaurus.
+
+
+
При предоставлении доступа к своему сайту через ваш собственный веб-сервер, убедитесь, что сервер передает статические ресурсы с корректными HTTP заголовками. Файлы css должны быть переданы с заголовком content-type, имеющий значение text/css. В случае Nginx это значит, что вам следует добавить строку include /etc/nginx/mime.types; в файл nginx.conf. Просмотрите это обращение для получения дополнительной информации.
Запустите команду внутри корневого каталога вашего проекта:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Использование GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
Даже если ваш репозиторий является приватным, все, что публикуется в ветке gh-pages станет публичным.
+
+
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).
+
+
Вам потребуется изменить файл website/siteConfig.js и добавить необходимые параметры.
+
+
+
+
Наименование
Описание
+
+
+
organizationName
GitHub пользователь или организация, являющаяся владельцем репозитория. Если вы владелец проекта, то эта настройка - наименование вашей учетной записи на GitHub. In the case of Docusaurus, that would be the "facebook" GitHub organization.
+
projectName
Наименование репозитория GitHub для вашего проекта. Например, исходный код Docusaurus размещен по адресу https://github.com/facebook/docusaurus, поэтому наш проект в этом случае будет называться «docusaurus».
+
url
URL-aдрес вашего сайта. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Базовый URL-адрес для вашего проекта. For projects hosted on GitHub pages, it follows the format "/projectName/". Для https://github.com/facebook/docusaurus, baseUrl равен /docusaurus/.
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.
+
+
Хотя мы рекомендуем установить projectName и organizationName в siteConfig.js, вы также можете использовать переменные окружения ORGANIZATION_NAME и PROJECT_NAME.
+
+
+
Теперь вы должны указать пользователя git как переменную окружения и запустить сценарий publish-gh-pages
+
+
+
+
Наименование
Описание
+
+
+
GIT_USER
Имя пользователя для учётной записи GitHub, которая имеет доступ к данному репозиторию. Для ваших собственных репозиториев это будет обычное имя пользователя GitHub. Указанный GIT_USER должен иметь доступ к хранилищу, указанному в комбинации organizationName и projectName.
+
+
+
Чтобы запустить скрипт непосредственно из командной строки, вы можете использовать следующую команду, заполняя значения параметров соответствующим образом.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # или `npm run publish-gh-pages`
+
Есть также два необязательных параметра, которые задаются в качестве переменных окружения:
+
+
+
Наименование
Описание
+
+
+
USE_SSH
Если задано значение true, то используется SSH вместо HTTPS для подключения к репозиторию GitHub. HTTPS используется по умолчанию, если эта переменная не задана.
+
CURRENT_BRANCH
Ветвь, содержащая последние изменения для документов, которые будут развернуты. Обычно используется ветвь master, но это может быть любая ветвь (default или любая другая) за исключением gh-pages. Если значение не указано, будет использована текущая ветвь.
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 cnamesiteConfig option.
+
Мы настоятельно рекомендуем ознакомиться с документацией GitHub Pages, чтобы узнать больше о том, как работает это решение для хостинга.
+
Вы можете запустить приведенную выше команду в любое время, когда вы обновляете документы и хотите развернуть изменения на своем сайте. Запуск сценария вручную может быть полезен для сайтов, на которых документация редко изменяется, и не следует забывать о том, что нужно вручную вносить изменения.
+
Однако вы можете автоматизировать процесс публикации с помощью непрерывной интеграции (CI).
+
Автоматизация развертываний с использованием непрерывной интеграции
+
Службы непрерывной интеграции (CI) обычно используются для выполнения рутинных задач всякий раз, когда новые коммиты регистрируются в системе контроля версий. Этими задачами могут быть любое сочетание запуска модульных и интеграционных тестов, автоматизации сборок, публикации пакетов в NPM и, конечно же, развертывания изменений на вашем веб-сайте. Все, что вам нужно сделать для автоматизации развертывания вашего сайта, - это запускать сценарий publish-gh-pages всякий раз, когда ваши документы обновляются. В следующем разделе мы расскажем, как это сделать, используя Circle CI, популярного поставщика услуг непрерывной интеграции.
+
Using CircleCI 2.0
+
Если вы еще этого не сделали, вы можете установить CircleCI для своего проекта с открытым исходным кодом. После этого, чтобы включить автоматическое развертывание вашего сайта и документации через CircleCI, просто настройте Circle для запуска сценария publish-gh-pages на этапе развертывания. Для настройки вы можете выполнить следующие шаги.
+
+
Убедитесь, что учетная запись GitHub, которая будет установлена как GIT_USER, имеет права на запись в репозитории, содержащем документацию, проверив Settings | Collaborators & teams в репозитории.
+
Войдите в GitHub как GIT_USER.
+
Перейдите в https://github.com/settings/tokens для GIT_USER и создайте новый токен личного доступа, предоставив ему полный контроль над частными репозиториями через доступ к repository. Храните этот токен в безопасном месте, не передавая его никому. Этот токен может использоваться для аутентификации действий на GitHub от вашего имени вместо вашего пароля на GitHub.
+
Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". URL выглядит как https://circleci.com/gh/ORG/REPO/edit#env-vars, где «ORG / REPO» должен быть заменен вашей собственной организацией/репозиторием на GitHub.
+
Создайте новую переменную среды с именем GITHUB_TOKEN, используя в качестве значения вновь созданный токен доступа.
+
Создайте каталог .circleci и config.yml в этом каталоге.
+
Скопируйте приведенный ниже текст в .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
Обязательно замените все <....> в последовательности command: соответствующими значениями. Для <GIT_USER> это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев <GIT_USER> и <GITHUB_USERNAME> имеют одинаковые значения.
+
DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 5.
+
+
Если вы желаете использовать SSH для подключения к своему репозиторию GitHub, вы можете указать USE_SSH=true. Таким образом, команда выше будет выглядеть следующим образом: 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.
+
+
Теперь, когда новый коммит будет отправлен в master, CircleCI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.
+
+
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.
+
+
Советы и трюки
+
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).
+
Вы легко можете обойти это следующим образом:
+
+
Установите значение переменной окружения CUSTOM_COMMIT_MESSAGE для сценария publish-gh-pages равной [skip ci]. Например:
+
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+ yarn run publish-gh-pages # или `npm run publish-gh-pages`
+
+
+
Кроме того, вы можете обойти эту проблему, создав базовый файл настроек CircleCI со следующим содержимым:
+
+
# 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"
+
+
Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.
Откройте панель Travis CI. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
Создайте новую переменную окружения с именем GH_TOKEN и присвойте ей в качестве значения созданный токен, затем также создайте переменные GH_EMAIL (ваш email адрес) и GH_NAME (имя вашей учетной записи GitHub).
+
Создайте файл .travis.yml в корне своего репозитория со следующим текстом.
Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Шаги по настройке вашего Docusaurus-сайта на Netlify.
+
+
Select New site from Git
+
Подключитесь к своему провайдеру Git.
+
Выберите ветку для развертывания. По-умолчанию это master
+
Настройте шаги сборки:
+
+
Для команды сборки введите: cd website; npm install; npm run build;
+
Для каталога публикации: website/build/<projectName> (используйте projectName из своего siteConfig)
+
+
Click Deploy site
+
+
Вы также можете настроить Netlify для построения сайта после каждого коммита в вашем репозитории, или только для коммитов в ветке master.
+
Хостинг на Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Выберите ветку для развертывания. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
That's it! Your app will be live on your Render URL as soon as the build finishes.
+
Публикация на GitHub Enterprise
+
Публикация на GitHub Enterprise должна работать по той же схеме, что и на github.com; вам только лишь нужно определить хост организации на GitHub Enterprise.
+
+
+
Наименование
Описание
+
+
+
GITHUB_HOST
Имя хоста для сервера GitHub enterprise.
+
+
+
Добавьте в siteConfig.js поле 'githubHost', которое будет содержать наименование хоста на GitHub Enterprise. Также вместо этого вы можете указать переменную окружения GITHUB_HOST при вызове команды публикации.
\ No newline at end of file
diff --git a/docs/ru/publishing/index.html b/docs/ru/publishing/index.html
new file mode 100644
index 0000000000..9672fcd9f1
--- /dev/null
+++ b/docs/ru/publishing/index.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
Теперь у вас должен быть настроенный и запущенный локально сайт. Как только вы настроили его по своему вкусу, настало время опубликовать его. Docusaurus создает статический HTML веб-сайт, готовый к запуску на на вашем любимом веб-сервере или через онлайн хостинг.
+
Создание статических HTML страниц
+
Чтобы создать статическую сборку своего веб-сайта, запустите следующую команду из каталога website:
+
yarn run build # или `npm run build`
+
+
В результате будет создан каталог build внутри каталога website, содержащий файлы .html для всех документов и других страниц, размещенных в pages.
+
Хостинг статических HTML страниц
+
На этом этапе вы можете взять все файлы из каталога website/build и скопировать их в каталог html на вашем любимом веб-сервере.
+
+
Например, Apache и Nginx обслуживают содержимое каталога /var/www/html по-умолчанию. Впрочем, выбор веб-сервера или провайдера выходит за рамки Docusaurus.
+
+
+
При предоставлении доступа к своему сайту через ваш собственный веб-сервер, убедитесь, что сервер передает статические ресурсы с корректными HTTP заголовками. Файлы css должны быть переданы с заголовком content-type, имеющий значение text/css. В случае Nginx это значит, что вам следует добавить строку include /etc/nginx/mime.types; в файл nginx.conf. Просмотрите это обращение для получения дополнительной информации.
Запустите команду внутри корневого каталога вашего проекта:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Использование GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
Даже если ваш репозиторий является приватным, все, что публикуется в ветке gh-pages станет публичным.
+
+
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).
+
+
Вам потребуется изменить файл website/siteConfig.js и добавить необходимые параметры.
+
+
+
+
Наименование
Описание
+
+
+
organizationName
GitHub пользователь или организация, являющаяся владельцем репозитория. Если вы владелец проекта, то эта настройка - наименование вашей учетной записи на GitHub. In the case of Docusaurus, that would be the "facebook" GitHub organization.
+
projectName
Наименование репозитория GitHub для вашего проекта. Например, исходный код Docusaurus размещен по адресу https://github.com/facebook/docusaurus, поэтому наш проект в этом случае будет называться «docusaurus».
+
url
URL-aдрес вашего сайта. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Базовый URL-адрес для вашего проекта. For projects hosted on GitHub pages, it follows the format "/projectName/". Для https://github.com/facebook/docusaurus, baseUrl равен /docusaurus/.
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.
+
+
Хотя мы рекомендуем установить projectName и organizationName в siteConfig.js, вы также можете использовать переменные окружения ORGANIZATION_NAME и PROJECT_NAME.
+
+
+
Теперь вы должны указать пользователя git как переменную окружения и запустить сценарий publish-gh-pages
+
+
+
+
Наименование
Описание
+
+
+
GIT_USER
Имя пользователя для учётной записи GitHub, которая имеет доступ к данному репозиторию. Для ваших собственных репозиториев это будет обычное имя пользователя GitHub. Указанный GIT_USER должен иметь доступ к хранилищу, указанному в комбинации organizationName и projectName.
+
+
+
Чтобы запустить скрипт непосредственно из командной строки, вы можете использовать следующую команду, заполняя значения параметров соответствующим образом.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # или `npm run publish-gh-pages`
+
Есть также два необязательных параметра, которые задаются в качестве переменных окружения:
+
+
+
Наименование
Описание
+
+
+
USE_SSH
Если задано значение true, то используется SSH вместо HTTPS для подключения к репозиторию GitHub. HTTPS используется по умолчанию, если эта переменная не задана.
+
CURRENT_BRANCH
Ветвь, содержащая последние изменения для документов, которые будут развернуты. Обычно используется ветвь master, но это может быть любая ветвь (default или любая другая) за исключением gh-pages. Если значение не указано, будет использована текущая ветвь.
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 cnamesiteConfig option.
+
Мы настоятельно рекомендуем ознакомиться с документацией GitHub Pages, чтобы узнать больше о том, как работает это решение для хостинга.
+
Вы можете запустить приведенную выше команду в любое время, когда вы обновляете документы и хотите развернуть изменения на своем сайте. Запуск сценария вручную может быть полезен для сайтов, на которых документация редко изменяется, и не следует забывать о том, что нужно вручную вносить изменения.
+
Однако вы можете автоматизировать процесс публикации с помощью непрерывной интеграции (CI).
+
Автоматизация развертываний с использованием непрерывной интеграции
+
Службы непрерывной интеграции (CI) обычно используются для выполнения рутинных задач всякий раз, когда новые коммиты регистрируются в системе контроля версий. Этими задачами могут быть любое сочетание запуска модульных и интеграционных тестов, автоматизации сборок, публикации пакетов в NPM и, конечно же, развертывания изменений на вашем веб-сайте. Все, что вам нужно сделать для автоматизации развертывания вашего сайта, - это запускать сценарий publish-gh-pages всякий раз, когда ваши документы обновляются. В следующем разделе мы расскажем, как это сделать, используя Circle CI, популярного поставщика услуг непрерывной интеграции.
+
Using CircleCI 2.0
+
Если вы еще этого не сделали, вы можете установить CircleCI для своего проекта с открытым исходным кодом. После этого, чтобы включить автоматическое развертывание вашего сайта и документации через CircleCI, просто настройте Circle для запуска сценария publish-gh-pages на этапе развертывания. Для настройки вы можете выполнить следующие шаги.
+
+
Убедитесь, что учетная запись GitHub, которая будет установлена как GIT_USER, имеет права на запись в репозитории, содержащем документацию, проверив Settings | Collaborators & teams в репозитории.
+
Войдите в GitHub как GIT_USER.
+
Перейдите в https://github.com/settings/tokens для GIT_USER и создайте новый токен личного доступа, предоставив ему полный контроль над частными репозиториями через доступ к repository. Храните этот токен в безопасном месте, не передавая его никому. Этот токен может использоваться для аутентификации действий на GitHub от вашего имени вместо вашего пароля на GitHub.
+
Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". URL выглядит как https://circleci.com/gh/ORG/REPO/edit#env-vars, где «ORG / REPO» должен быть заменен вашей собственной организацией/репозиторием на GitHub.
+
Создайте новую переменную среды с именем GITHUB_TOKEN, используя в качестве значения вновь созданный токен доступа.
+
Создайте каталог .circleci и config.yml в этом каталоге.
+
Скопируйте приведенный ниже текст в .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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
+
+
Обязательно замените все <....> в последовательности command: соответствующими значениями. Для <GIT_USER> это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев <GIT_USER> и <GITHUB_USERNAME> имеют одинаковые значения.
+
DO NOT place the actual value of $GITHUB_TOKEN in circle.yml. We already configured that as an environment variable back in Step 5.
+
+
Если вы желаете использовать SSH для подключения к своему репозиторию GitHub, вы можете указать USE_SSH=true. Таким образом, команда выше будет выглядеть следующим образом: 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.
+
+
Теперь, когда новый коммит будет отправлен в master, CircleCI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.
+
+
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.
+
+
Советы и трюки
+
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).
+
Вы легко можете обойти это следующим образом:
+
+
Установите значение переменной окружения CUSTOM_COMMIT_MESSAGE для сценария publish-gh-pages равной [skip ci]. Например:
+
+
CUSTOM_COMMIT_MESSAGE="[skip ci]" \
+ yarn run publish-gh-pages # или `npm run publish-gh-pages`
+
+
+
Кроме того, вы можете обойти эту проблему, создав базовый файл настроек CircleCI со следующим содержимым:
+
+
# 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"
+
+
Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.
Откройте панель Travis CI. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the More options > Setting > Environment Variables section of your repository.
+
Создайте новую переменную окружения с именем GH_TOKEN и присвойте ей в качестве значения созданный токен, затем также создайте переменные GH_EMAIL (ваш email адрес) и GH_NAME (имя вашей учетной записи GitHub).
+
Создайте файл .travis.yml в корне своего репозитория со следующим текстом.
Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Шаги по настройке вашего Docusaurus-сайта на Netlify.
+
+
Select New site from Git
+
Подключитесь к своему провайдеру Git.
+
Выберите ветку для развертывания. По-умолчанию это master
+
Настройте шаги сборки:
+
+
Для команды сборки введите: cd website; npm install; npm run build;
+
Для каталога публикации: website/build/<projectName> (используйте projectName из своего siteConfig)
+
+
Click Deploy site
+
+
Вы также можете настроить Netlify для построения сайта после каждого коммита в вашем репозитории, или только для коммитов в ветке master.
+
Хостинг на Render
+
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Выберите ветку для развертывания. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
That's it! Your app will be live on your Render URL as soon as the build finishes.
+
Публикация на GitHub Enterprise
+
Публикация на GitHub Enterprise должна работать по той же схеме, что и на github.com; вам только лишь нужно определить хост организации на GitHub Enterprise.
+
+
+
Наименование
Описание
+
+
+
GITHUB_HOST
Имя хоста для сервера GitHub enterprise.
+
+
+
Добавьте в siteConfig.js поле 'githubHost', которое будет содержать наименование хоста на GitHub Enterprise. Также вместо этого вы можете указать переменную окружения GITHUB_HOST при вызове команды публикации.
\ No newline at end of file
diff --git a/docs/ru/search.html b/docs/ru/search.html
new file mode 100644
index 0000000000..8c95bbda07
--- /dev/null
+++ b/docs/ru/search.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
Docusaurus поддерживает поиск с помощью Algolia DocSearch. Как только ваш веб-сайт станет доступен онлайн, вы можете предоставить его в DocSearch. Затем Algolia отправит учетные данные, которые можно добавить в ваш siteConfig.js.
+
DocSearch обходит страницы вашего веб-сайта каждые 24 часа и добавляет их содержимое в индекс Algolia. Затем это содержимое будет запрошено непосредственно из вашего клиентского интерфейса с помощью Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). Этот сервис бесплатный.
+
Подключение панели поиска
+
Добавьте свой ключ API и имя индекса (предоставленные сервисом Algolia), в файл siteConfig.js в секцию algolia, чтобы подключить поиск на своем сайте.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Дополнительные параметры поиска
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Это может быть полезно, если вы желаете предоставить разные результаты поиска для различных версий или языков документации. Любое вхождение "VERSION" или "LANGUAGE" будет заменено на версию или язык текущей страницы соответственно. Больше информации о параметрах поиска вы можете найти здесь.
Algolia might provide you with extra search options. В этом случае вам следует добавить их в объект algoliaOptions.
+
Настройка местоположения панели поиска
+
По-умолчанию панель поиска размещается как крайний правый элемент в верхней панели навигации.
+
Если вы желаете изменить местоположение по-умолчанию, добавьте флаг searchBar в поле headerLinks из siteConfig.js в том месте, где вам нужно. Например, вы можете пожелать разместить панель поиска между своими внутренними и внешними ссылками.
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:
\ No newline at end of file
diff --git a/docs/ru/search/index.html b/docs/ru/search/index.html
new file mode 100644
index 0000000000..8c95bbda07
--- /dev/null
+++ b/docs/ru/search/index.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
Docusaurus поддерживает поиск с помощью Algolia DocSearch. Как только ваш веб-сайт станет доступен онлайн, вы можете предоставить его в DocSearch. Затем Algolia отправит учетные данные, которые можно добавить в ваш siteConfig.js.
+
DocSearch обходит страницы вашего веб-сайта каждые 24 часа и добавляет их содержимое в индекс Algolia. Затем это содержимое будет запрошено непосредственно из вашего клиентского интерфейса с помощью Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). Этот сервис бесплатный.
+
Подключение панели поиска
+
Добавьте свой ключ API и имя индекса (предоставленные сервисом Algolia), в файл siteConfig.js в секцию algolia, чтобы подключить поиск на своем сайте.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Дополнительные параметры поиска
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. Это может быть полезно, если вы желаете предоставить разные результаты поиска для различных версий или языков документации. Любое вхождение "VERSION" или "LANGUAGE" будет заменено на версию или язык текущей страницы соответственно. Больше информации о параметрах поиска вы можете найти здесь.
Algolia might provide you with extra search options. В этом случае вам следует добавить их в объект algoliaOptions.
+
Настройка местоположения панели поиска
+
По-умолчанию панель поиска размещается как крайний правый элемент в верхней панели навигации.
+
Если вы желаете изменить местоположение по-умолчанию, добавьте флаг searchBar в поле headerLinks из siteConfig.js в том месте, где вам нужно. Например, вы можете пожелать разместить панель поиска между своими внутренними и внешними ссылками.
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:
\ No newline at end of file
diff --git a/docs/ru/site-config.html b/docs/ru/site-config.html
new file mode 100644
index 0000000000..215f7322d5
--- /dev/null
+++ b/docs/ru/site-config.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
Большая часть настроек сайта размещена в файле siteConfig.js.
+
Витрина пользователей
+
Массив объектов users используется для хранения информации о каждом пользователе/проекте, который вы желаете показать на своем сайте. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Каждый объект в массиве должен иметь поля caption, image, infoLink, и pinned. Текст caption отображается, когда кто-либо наводит курсор на изображение image этого пользователя, а infoLink - адрес, по которому произойдет переход при щелчке на него. Поле pinned определяет, должен ли пользователь быть отображен на странице index.
+
В настоящее время массив users используется только в примерах файлов index.js и users.js. Если вы не желаете иметь страницу с витриной пользователей и соответствующий раздел на странице index, вы можете удалить эту секцию.
+
Поля siteConfig
+
Объект siteConfig содержит основную часть настроек вашего веб-сайта.
+
Обязательные поля
+
baseUrl [string]
+
Базовый URL вашего сайта. Этот URL может также считаться путем после домена. Например, /metro/ - baseUrl для https://facebook.github.io/metro/. Для URL-адресов без базового пути baseUrl должен быть равен /. Это поле связано с полем url.
+
colors [object]
+
Описание цветовой схемы вашего сайта.
+
+
primaryColor это цвет, используемый в панели навигации в шапке сайта и боковых панелях.
+
secondaryColor это цвет, который можно увидеть во второй строке панели навигации в шапке страницы, когда окно браузера узкое (в том числе и на мобильных устройствах).
+
Также могут быть добавлены пользовательские цвета. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
copyright [string]
+
Строка копирайта в футере сайта и в пределах ленты
+
favicon [string]
+
URL иконки-значка favicon вашего сайта.
+
headerIcon [string]
+
URL иконки, используемой в навигационной панели в шапке страницы.
+
headerLinks [array]
+
Ссылки, которые будут использованы в навигационной панели в шапке страницы. Поле label каждого объекта будет использовано как текст ссылки и также переведено на каждый язык вашего сайта.
+
Пример использования:
+
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, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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, принадлежаший организации/пользователю, предоставляющего данный проект. Эта настройка используется сценарием публикации для определения того, где на GitHub pages будет располагаться ваш веб-сайт.
+
projectName [string]
+
Наименование проекта. Должно соответствовать наименованию вашего GitHub репозитория (наименование регистрозависимое).
Настройки для интеграции с поисковой системой Algolia. Если это поле не указано, панель поиска не появится в шапке сайта. Вам следует указать два значения для этого поля, также вы можете указать одно необязательное (appId).
+
+
apiKey - API-ключ предоставленный Algolia для вашего поиска.
+
indexName - Algolia предоставляет имя индекса для поиска (обычно это имя проекта)
+
appId - Algolia по-умолчанию предоставляет скрапер для ваших документов. Если вы предоставите свой собственный, вы, вероятно, получите этот идентификатор от них.
+
+
blogSidebarCount [number]
+
Ограничение на количество сообщений вашего блога, одновременно отображаемых в боковой панели. Для получения дополнительной информации перейдите по ссылке - Добавление блогов.
+
blogSidebarTitle [string]
+
Заголовок боковой панели с сообщениями вашего блога. Для получения дополнительной информации перейдите по ссылке - Добавление блогов.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
cname [string]
+
CNAME для вашего веб-сайта. Значение данного параметра будет скопировано в файл CNAME, когда ваш сайт будет построен.
+
customDocsPath [string]
+
По-умолчанию Docusaurus ожидает, что ваша документация размещена в каталоге docs. Этот каталог размещен на том же уровне, что и каталог website (т.е. не внутри каталога website). Вы можете указать свой собственный каталог для вашей документации в этом поле.
+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+
defaultVersionShown [string]
+
Версия, отображаемая на сайте по-умолчанию. Если не указана, будет отображена последняя версия.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
docsUrl [string]
+
Базовый URL для всех файлов документации. Установите это поле равным '' чотбы удалить префикс docs из URL документации. По-умолчанию равно docs.
+
disableHeaderTitle [boolean]
+
Данная настройка позволяет отключить показ заголовка в шапке страницы рядом с изображением-значком. Удалите это поле, чтобы сохранить нормальный режим отображения шапки страницы, или же установите его значение равным true.
+
disableTitleTagline [boolean]
+
Настройка, отключающая отображение подзаголовка в заголовке основных страниц. Удалите это поле, чтобы сохранить заголовки страниц вида Title • Tagline. Установите его равным true, чтобы заголовки имели вид Title.
+
docsSideNavCollapsible [boolean]
+
Установите это значение равным true, если желаете, чтобы в боковой панели можно было раскрывать/скрывать ссылки и подкатегории.
+
editUrl [string]
+
URL для редактирования документов, пример использования: editUrl + 'en/doc1.md'. Если это поле не указано, документы не будут содержать кнопку "Редактировать этот документ".
+
enableUpdateBy [boolean]
+
Этот параметр используется для подключения отображения автора последних правок вашей документации. Установите значение параметра равным true чтобы отобразить сроку в нижнем правом углу каждого документа вида Last updated by <Author Name>.
+
enableUpdateTime [boolean]
+
Логическое значение, указвающее, нужно ли отображать время последнего обновления документации. Установите равным true, чтобы отобразить строку в правом нижнем углу каждого документа со следующим содержимым: Обновлено: <date>.
+
facebookAppId [string]
+
Если вы желаете подключить кнопки Facebook "Нравится"/"Поделиться" в футере и нижней части сообщения вашего блога, укажите идентификатор приложения Facebook.
+
facebookComments [boolean]
+
Установите данный параметр равным true, если желаете подключить комментарии Facebook в нижней части сообщения вашего блога. facebookAppId также должен быть указан.
+
facebookPixelId [string]
+
Facebook Pixel Идентификатор для отслеживания количества посещений.
+
fonts [object]
+
Параметр CSS font-family для сайта. Если семейство шрифтов указано в siteConfig.js как $myFont, то добавление ключа myFont в массив fonts позволит вам настроить шрифт. Элементы в начале массива имеют более высокий приоритет по сравнению с последующими элементами, так что порядок шрифтов имеет значение.
+
В примере ниже у нас есть два набора настроек шрифтов, myFont и myOtherFont. Times New Roman - предпочитаемый шрифт в myFont. -apple-system - предпочитаемый шрифт в myOtherFont.
{
+ // ...
+ highlight: {
+ // Наименование темы, используемой Highlight.js для подсветки кода.
+ // Вы можете просмотреть список поддерживаемых тем здесь:
+ // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+ theme: 'default',
+
+ // Конкретная версия Highlight.js, которая будет использована.
+ version: '9.12.0',
+
+ // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
+ hljs: function(highlightJsInstance) {
+ // ваш код
+ },
+
+ // Язык по-умолчанию.
+ // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
+ // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+ defaultLang: 'javascript',
+
+ // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
+ themeUrl: 'http://foo.bar/custom.css'
+ },
+}
+
+
manifest [string]
+
Путь к манифесту веб-приложения (например, manifest.json). На страницу будет добавлен тег <link> в секции <head> с параметрами rel со значением "manifest" и href равным указанному пути.
+
markdownOptions [object]
+
Override default Remarkable options that will be used to render markdown.
Массив плагинов, которые должен загрузить Remarkable - markdown анализатор и обработчик, используемый Docusaurus. Плагин получит ссылку на экземпляр Remarkable, позволяя определить пользовательские правила анализа и визуализации.
+
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:
Логическое значение. Если равно true, Docusaurus вежливо попросит краулеры и поисковые машины не индексировать ваш сайт. Данная настройка указывается в тэге header, в следствие этого применяется только к документам и страницам. Статические ресурсы не будут скрыты. Это наибольшее, что можно сделать. Вредоносные краулеры могут, и, вероятно, будут индексировать ваш сайт.
+
ogImage [string]
+
Локальный путь к изображению Open Graph (Например, img/myImage.png). Данное изображение используется, если ссылкой на ваш сайт поделились в Facebook или любых других сайтах/приложениях, поддерживающих протокол Open Graph.
+
onPageNav [string]
+
Если вам нужна видимый вариант навигации для представления тем на текущей странице. В настоящее время существует только одно доступное значение:
Массив сценариев JavaScript для загрузки. Значения могут быть либо строками, либо обычными объектами карт атрибута-значения. Обратитесь к примеру ниже. Тег script будет вставлен в секцию HTML head.
+
separateCss [array]
+
Каталоги, внутри которых любые CSS файлы не будут обработаны и присоеденены к стилям Docusaurus. Эта настройка предназначена для поддержки статических HTML страниц, которые могут быть отделены от Docusaurus и иметь свои собственные отдельные стили.
+
scrollToTop [boolean]
+
Установите значение параметра равным true, если вы желаете добавить кнопку прокрутки страницы вверх в нижней части вашего сайта.
+
scrollToTopOptions [object]
+
Дополнительные настройки кнопки прокрутки страницы наверх. Данный параметр не требуется изменять, даже если вы установили scrollToTop равным true; параметр просто предоставляет вам больше настроек для кнопки. Вы можете узнать больше об этом здесь. По-умолчанию параметр zIndex равен 100.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
stylesheets [array]
+
Массив стилей CSS для загрузки. Значения могут быть либо строками, либо обычными объектами карт атрибута-значения. Тег link будет вставлен в секцию HTML head.
+
translationRecruitingLink [string]
+
URL для пункта Помочь с переводом в меню выбора языка, если для документации доступны другие языки, помимо Английского. Поле может быть указано, если вы используете переводы, но это не обязательно.
+
twitter [boolean]
+
Установите это значение равным true, если желаете добавить кнопку социальной сети Twitter в нижней части ленты вашего блога.
+
twitterUsername [string]
+
Если вы желаете добавить кнопку Twitter follow в нижней части вашей страницы, укажите наименование учетной записи Twitter. Например: docusaurus.
+
twitterImage [string]
+
Локальный путь к изображению для карточки Twitter (например, img/myImage.png). Это изображение будет показано в карточке Twitter, когда ссылкой на ваш сайт поделятся в этой социальной сети.
+
useEnglishUrl [string]
+
Если вы не включили перевод текста (например, создав файл languages.js), но все еще желаете иметь ссылку вида /docs/en/doc.html (с подстрокой en), установите это поле равным true.
Логическое значение, указывающее, должны ли HTML-файлы в /pages быть дополнены стилями, шапкой и футером сайта, сгенерированного Docusaurus. Данная функциональность является экспериментальной и предполагает, что будут использоваться файлы, содержащие HTML фрагменты вместо законченных страниц. Содержимое вашего HTML файла будет добавлено без дополнительной обработки. Значение по умолчанию: false.
+
Пользователи также могут добавить свои собственные поля, если желают предоставить некоторую информацию в различных файлах.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ No newline at end of file
diff --git a/docs/ru/site-config/index.html b/docs/ru/site-config/index.html
new file mode 100644
index 0000000000..215f7322d5
--- /dev/null
+++ b/docs/ru/site-config/index.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
Большая часть настроек сайта размещена в файле siteConfig.js.
+
Витрина пользователей
+
Массив объектов users используется для хранения информации о каждом пользователе/проекте, который вы желаете показать на своем сайте. Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. Каждый объект в массиве должен иметь поля caption, image, infoLink, и pinned. Текст caption отображается, когда кто-либо наводит курсор на изображение image этого пользователя, а infoLink - адрес, по которому произойдет переход при щелчке на него. Поле pinned определяет, должен ли пользователь быть отображен на странице index.
+
В настоящее время массив users используется только в примерах файлов index.js и users.js. Если вы не желаете иметь страницу с витриной пользователей и соответствующий раздел на странице index, вы можете удалить эту секцию.
+
Поля siteConfig
+
Объект siteConfig содержит основную часть настроек вашего веб-сайта.
+
Обязательные поля
+
baseUrl [string]
+
Базовый URL вашего сайта. Этот URL может также считаться путем после домена. Например, /metro/ - baseUrl для https://facebook.github.io/metro/. Для URL-адресов без базового пути baseUrl должен быть равен /. Это поле связано с полем url.
+
colors [object]
+
Описание цветовой схемы вашего сайта.
+
+
primaryColor это цвет, используемый в панели навигации в шапке сайта и боковых панелях.
+
secondaryColor это цвет, который можно увидеть во второй строке панели навигации в шапке страницы, когда окно браузера узкое (в том числе и на мобильных устройствах).
+
Также могут быть добавлены пользовательские цвета. For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
copyright [string]
+
Строка копирайта в футере сайта и в пределах ленты
+
favicon [string]
+
URL иконки-значка favicon вашего сайта.
+
headerIcon [string]
+
URL иконки, используемой в навигационной панели в шапке страницы.
+
headerLinks [array]
+
Ссылки, которые будут использованы в навигационной панели в шапке страницы. Поле label каждого объекта будет использовано как текст ссылки и также переведено на каждый язык вашего сайта.
+
Пример использования:
+
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, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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, принадлежаший организации/пользователю, предоставляющего данный проект. Эта настройка используется сценарием публикации для определения того, где на GitHub pages будет располагаться ваш веб-сайт.
+
projectName [string]
+
Наименование проекта. Должно соответствовать наименованию вашего GitHub репозитория (наименование регистрозависимое).
Настройки для интеграции с поисковой системой Algolia. Если это поле не указано, панель поиска не появится в шапке сайта. Вам следует указать два значения для этого поля, также вы можете указать одно необязательное (appId).
+
+
apiKey - API-ключ предоставленный Algolia для вашего поиска.
+
indexName - Algolia предоставляет имя индекса для поиска (обычно это имя проекта)
+
appId - Algolia по-умолчанию предоставляет скрапер для ваших документов. Если вы предоставите свой собственный, вы, вероятно, получите этот идентификатор от них.
+
+
blogSidebarCount [number]
+
Ограничение на количество сообщений вашего блога, одновременно отображаемых в боковой панели. Для получения дополнительной информации перейдите по ссылке - Добавление блогов.
+
blogSidebarTitle [string]
+
Заголовок боковой панели с сообщениями вашего блога. Для получения дополнительной информации перейдите по ссылке - Добавление блогов.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
cname [string]
+
CNAME для вашего веб-сайта. Значение данного параметра будет скопировано в файл CNAME, когда ваш сайт будет построен.
+
customDocsPath [string]
+
По-умолчанию Docusaurus ожидает, что ваша документация размещена в каталоге docs. Этот каталог размещен на том же уровне, что и каталог website (т.е. не внутри каталога website). Вы можете указать свой собственный каталог для вашей документации в этом поле.
+
customDocsPath: 'docs/site';
+
+
customDocsPath: 'website-docs';
+
+
defaultVersionShown [string]
+
Версия, отображаемая на сайте по-умолчанию. Если не указана, будет отображена последняя версия.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
docsUrl [string]
+
Базовый URL для всех файлов документации. Установите это поле равным '' чотбы удалить префикс docs из URL документации. По-умолчанию равно docs.
+
disableHeaderTitle [boolean]
+
Данная настройка позволяет отключить показ заголовка в шапке страницы рядом с изображением-значком. Удалите это поле, чтобы сохранить нормальный режим отображения шапки страницы, или же установите его значение равным true.
+
disableTitleTagline [boolean]
+
Настройка, отключающая отображение подзаголовка в заголовке основных страниц. Удалите это поле, чтобы сохранить заголовки страниц вида Title • Tagline. Установите его равным true, чтобы заголовки имели вид Title.
+
docsSideNavCollapsible [boolean]
+
Установите это значение равным true, если желаете, чтобы в боковой панели можно было раскрывать/скрывать ссылки и подкатегории.
+
editUrl [string]
+
URL для редактирования документов, пример использования: editUrl + 'en/doc1.md'. Если это поле не указано, документы не будут содержать кнопку "Редактировать этот документ".
+
enableUpdateBy [boolean]
+
Этот параметр используется для подключения отображения автора последних правок вашей документации. Установите значение параметра равным true чтобы отобразить сроку в нижнем правом углу каждого документа вида Last updated by <Author Name>.
+
enableUpdateTime [boolean]
+
Логическое значение, указвающее, нужно ли отображать время последнего обновления документации. Установите равным true, чтобы отобразить строку в правом нижнем углу каждого документа со следующим содержимым: Обновлено: <date>.
+
facebookAppId [string]
+
Если вы желаете подключить кнопки Facebook "Нравится"/"Поделиться" в футере и нижней части сообщения вашего блога, укажите идентификатор приложения Facebook.
+
facebookComments [boolean]
+
Установите данный параметр равным true, если желаете подключить комментарии Facebook в нижней части сообщения вашего блога. facebookAppId также должен быть указан.
+
facebookPixelId [string]
+
Facebook Pixel Идентификатор для отслеживания количества посещений.
+
fonts [object]
+
Параметр CSS font-family для сайта. Если семейство шрифтов указано в siteConfig.js как $myFont, то добавление ключа myFont в массив fonts позволит вам настроить шрифт. Элементы в начале массива имеют более высокий приоритет по сравнению с последующими элементами, так что порядок шрифтов имеет значение.
+
В примере ниже у нас есть два набора настроек шрифтов, myFont и myOtherFont. Times New Roman - предпочитаемый шрифт в myFont. -apple-system - предпочитаемый шрифт в myOtherFont.
{
+ // ...
+ highlight: {
+ // Наименование темы, используемой Highlight.js для подсветки кода.
+ // Вы можете просмотреть список поддерживаемых тем здесь:
+ // https://github.com/isagalaev/highlight.js/tree/master/src/styles
+ theme: 'default',
+
+ // Конкретная версия Highlight.js, которая будет использована.
+ version: '9.12.0',
+
+ // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
+ hljs: function(highlightJsInstance) {
+ // ваш код
+ },
+
+ // Язык по-умолчанию.
+ // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
+ // https://github.com/isagalaev/highlight.js/tree/master/src/languages
+
+ defaultLang: 'javascript',
+
+ // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
+ themeUrl: 'http://foo.bar/custom.css'
+ },
+}
+
+
manifest [string]
+
Путь к манифесту веб-приложения (например, manifest.json). На страницу будет добавлен тег <link> в секции <head> с параметрами rel со значением "manifest" и href равным указанному пути.
+
markdownOptions [object]
+
Override default Remarkable options that will be used to render markdown.
Массив плагинов, которые должен загрузить Remarkable - markdown анализатор и обработчик, используемый Docusaurus. Плагин получит ссылку на экземпляр Remarkable, позволяя определить пользовательские правила анализа и визуализации.
+
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:
Логическое значение. Если равно true, Docusaurus вежливо попросит краулеры и поисковые машины не индексировать ваш сайт. Данная настройка указывается в тэге header, в следствие этого применяется только к документам и страницам. Статические ресурсы не будут скрыты. Это наибольшее, что можно сделать. Вредоносные краулеры могут, и, вероятно, будут индексировать ваш сайт.
+
ogImage [string]
+
Локальный путь к изображению Open Graph (Например, img/myImage.png). Данное изображение используется, если ссылкой на ваш сайт поделились в Facebook или любых других сайтах/приложениях, поддерживающих протокол Open Graph.
+
onPageNav [string]
+
Если вам нужна видимый вариант навигации для представления тем на текущей странице. В настоящее время существует только одно доступное значение:
Массив сценариев JavaScript для загрузки. Значения могут быть либо строками, либо обычными объектами карт атрибута-значения. Обратитесь к примеру ниже. Тег script будет вставлен в секцию HTML head.
+
separateCss [array]
+
Каталоги, внутри которых любые CSS файлы не будут обработаны и присоеденены к стилям Docusaurus. Эта настройка предназначена для поддержки статических HTML страниц, которые могут быть отделены от Docusaurus и иметь свои собственные отдельные стили.
+
scrollToTop [boolean]
+
Установите значение параметра равным true, если вы желаете добавить кнопку прокрутки страницы вверх в нижней части вашего сайта.
+
scrollToTopOptions [object]
+
Дополнительные настройки кнопки прокрутки страницы наверх. Данный параметр не требуется изменять, даже если вы установили scrollToTop равным true; параметр просто предоставляет вам больше настроек для кнопки. Вы можете узнать больше об этом здесь. По-умолчанию параметр zIndex равен 100.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
stylesheets [array]
+
Массив стилей CSS для загрузки. Значения могут быть либо строками, либо обычными объектами карт атрибута-значения. Тег link будет вставлен в секцию HTML head.
+
translationRecruitingLink [string]
+
URL для пункта Помочь с переводом в меню выбора языка, если для документации доступны другие языки, помимо Английского. Поле может быть указано, если вы используете переводы, но это не обязательно.
+
twitter [boolean]
+
Установите это значение равным true, если желаете добавить кнопку социальной сети Twitter в нижней части ленты вашего блога.
+
twitterUsername [string]
+
Если вы желаете добавить кнопку Twitter follow в нижней части вашей страницы, укажите наименование учетной записи Twitter. Например: docusaurus.
+
twitterImage [string]
+
Локальный путь к изображению для карточки Twitter (например, img/myImage.png). Это изображение будет показано в карточке Twitter, когда ссылкой на ваш сайт поделятся в этой социальной сети.
+
useEnglishUrl [string]
+
Если вы не включили перевод текста (например, создав файл languages.js), но все еще желаете иметь ссылку вида /docs/en/doc.html (с подстрокой en), установите это поле равным true.
Логическое значение, указывающее, должны ли HTML-файлы в /pages быть дополнены стилями, шапкой и футером сайта, сгенерированного Docusaurus. Данная функциональность является экспериментальной и предполагает, что будут использоваться файлы, содержащие HTML фрагменты вместо законченных страниц. Содержимое вашего HTML файла будет добавлено без дополнительной обработки. Значение по умолчанию: false.
+
Пользователи также могут добавить свои собственные поля, если желают предоставить некоторую информацию в различных файлах.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ No newline at end of file
diff --git a/docs/ru/tutorial-create-pages.html b/docs/ru/tutorial-create-pages.html
new file mode 100644
index 0000000000..8dc576c3d6
--- /dev/null
+++ b/docs/ru/tutorial-create-pages.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/ru/tutorial-create-pages/index.html b/docs/ru/tutorial-create-pages/index.html
new file mode 100644
index 0000000000..8dc576c3d6
--- /dev/null
+++ b/docs/ru/tutorial-create-pages/index.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/ru/tutorial-version.html b/docs/ru/tutorial-version.html
new file mode 100644
index 0000000000..35d03bc454
--- /dev/null
+++ b/docs/ru/tutorial-version.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Выпуск версии
+
Убедитесь, что вас удовлетворяет текущее состояние документации и вы хотите зафиксировать его как документацию v1.0.0. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open docs/doc1.md and change the first line of the body:
+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Пример страницы
+---
+
+- Просмотрите [documentation](https://docusaurus.io), чтобы узнать, как использовать Docusaurus.
++ Это последняя версия документации.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+
If you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Предыдущие версии
+
Убедитесь, что документация изменена и нуждается в обновлении. Вы можете выпустить другую версию, например 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ No newline at end of file
diff --git a/docs/ru/tutorial-version/index.html b/docs/ru/tutorial-version/index.html
new file mode 100644
index 0000000000..35d03bc454
--- /dev/null
+++ b/docs/ru/tutorial-version/index.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Выпуск версии
+
Убедитесь, что вас удовлетворяет текущее состояние документации и вы хотите зафиксировать его как документацию v1.0.0. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open docs/doc1.md and change the first line of the body:
+
---
+id: doc1
+title: Latin-ish
+sidebar_label: Пример страницы
+---
+
+- Просмотрите [documentation](https://docusaurus.io), чтобы узнать, как использовать Docusaurus.
++ Это последняя версия документации.
+
+## Lorem
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies.
+
+
If you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
Next Version
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Предыдущие версии
+
Убедитесь, что документация изменена и нуждается в обновлении. Вы можете выпустить другую версию, например 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
Wrap Up
+
That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make 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.
\ No newline at end of file
diff --git a/docs/zh-CN/adding-blog.html b/docs/zh-CN/adding-blog.html
new file mode 100644
index 0000000000..3d57418608
--- /dev/null
+++ b/docs/zh-CN/adding-blog.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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:
Will be available at https://website/blog/introducing-docusaurus
+
顶部选项
+
The only required field is title; however, we provide options to add author information to your blog post as well along with other options.
+
+
author - 作者署名的文本标签。
+
authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
+
authorFBID - The Facebook profile ID that is used to fetch the profile picture.
+
authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
+
title - The blog post title.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
摘要截取
+
Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：
The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.
+
例如：
+
blogSidebarCount: 'ALL',
+
+
Changing The Sidebar Title
+
You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.
+
The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.
Docusaurus provides an 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 are used.
You can run your Docusaurus site without a landing page and instead have your blog load first.
+
To do this:
+
+
Create a file index.html in website/static/.
+
Place the contents of the template below into website/static/index.html
+
Customize the <title> of website/static/index.html
+
Delete the dynamic landing page website/pages/en/index.js
+
+
+
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>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/zh-CN/adding-blog/index.html b/docs/zh-CN/adding-blog/index.html
new file mode 100644
index 0000000000..3d57418608
--- /dev/null
+++ b/docs/zh-CN/adding-blog/index.html
@@ -0,0 +1,218 @@
+Adding a Blog · Docusaurus
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:
Will be available at https://website/blog/introducing-docusaurus
+
顶部选项
+
The only required field is title; however, we provide options to add author information to your blog post as well along with other options.
+
+
author - 作者署名的文本标签。
+
authorURL - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
+
authorFBID - The Facebook profile ID that is used to fetch the profile picture.
+
authorImageURL - The URL to the author's image. (Note: If you use both authorFBID and authorImageURL, authorFBID will take precedence. Don't include authorFBID if you want authorImageURL to appear.)
+
title - The blog post title.
+
slug - The blog post url slug. Example: /blog/my-test-slug. When not specified, the blog url slug will be extracted from the file name.
+
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.
+
draft - The post will not appear if set to true. Useful in situations where WIP but don't want to share the post.
+
+
摘要截取
+
Use the <!--truncate--> marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. <!--truncate--> 标记以上的内容都会成为摘要。 例如：
The available options are an integer representing the number of posts you wish to show or a string with the value 'ALL'.
+
例如：
+
blogSidebarCount: 'ALL',
+
+
Changing The Sidebar Title
+
You can configure a specific sidebar title by adding a blogSidebarTitle setting to your siteConfig.js.
+
The option is an object which can have the keys default and all. Specifying a value for default allows you to change the default sidebar title. Specifying a value for all allows you to change the sidebar title when the blogSidebarCount option is set to 'ALL'.
Docusaurus provides an 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 are used.
You can run your Docusaurus site without a landing page and instead have your blog load first.
+
To do this:
+
+
Create a file index.html in website/static/.
+
Place the contents of the template below into website/static/index.html
+
Customize the <title> of website/static/index.html
+
Delete the dynamic landing page website/pages/en/index.js
+
+
+
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>
+<htmllang="en-US">
+ <head>
+ <metacharset="UTF-8" />
+ <metahttp-equiv="refresh"content="0; url=blog/" />
+ <scripttype="text/javascript">
+ window.location.href = 'blog/';
+ </script>
+ <title>Title of Your Blog</title>
+ </head>
+ <body>
+ If you are not redirected automatically, follow this
+ <ahref="blog/">link</a>.
+ </body>
+</html>
+
\ No newline at end of file
diff --git a/docs/zh-CN/docker.html b/docs/zh-CN/docker.html
new file mode 100644
index 0000000000..3f489cd5d6
--- /dev/null
+++ b/docs/zh-CN/docker.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
使用 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:
+
+
Define your app’s environment with a Dockerfile so it can be reproduced anywhere.
+
Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.
+
Run docker-compose up and Compose starts and runs your entire app.
\ No newline at end of file
diff --git a/docs/zh-CN/docker/index.html b/docs/zh-CN/docker/index.html
new file mode 100644
index 0000000000..3f489cd5d6
--- /dev/null
+++ b/docs/zh-CN/docker/index.html
@@ -0,0 +1,154 @@
+Docker · Docusaurus
To access Docusaurus from outside the docker container you must add the --host flag to the docusaurus-start command as described in: API Commands
+
使用 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:
+
+
Define your app’s environment with a Dockerfile so it can be reproduced anywhere.
+
Define the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.
+
Run docker-compose up and Compose starts and runs your entire app.
\ No newline at end of file
diff --git a/docs/zh-CN/installation.html b/docs/zh-CN/installation.html
new file mode 100644
index 0000000000..356132a9b4
--- /dev/null
+++ b/docs/zh-CN/installation.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
\ No newline at end of file
diff --git a/docs/zh-CN/installation/index.html b/docs/zh-CN/installation/index.html
new file mode 100644
index 0000000000..356132a9b4
--- /dev/null
+++ b/docs/zh-CN/installation/index.html
@@ -0,0 +1,200 @@
+Installation · Docusaurus
\ No newline at end of file
diff --git a/docs/zh-CN/publishing.html b/docs/zh-CN/publishing.html
new file mode 100644
index 0000000000..c7b12525c9
--- /dev/null
+++ b/docs/zh-CN/publishing.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。
+
+
For example, both Apache and Nginx serve content from /var/www/html by default. 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。
+
+
+
当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 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.
Run a single command inside the root directory of your project:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Using GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
Name
说明
+
+
+
organizationName
The 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.
+
projectName
The 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
Name
说明
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your 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.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
There are also two optional parameters that are set as environment variables:
+
+
+
Name
说明
+
+
+
USE_SSH
If 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_BRANCH
The 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.
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 cnamesiteConfig 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 the 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.
+
+
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.
+
Log into GitHub as the GIT_USER.
+
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.
+
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.
+
Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
+
Create a .circleci directory and create a config.yml under that directory.
+
Copy the text below into .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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 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 your GitHub account, add the Travis CI app to the repository you want to activate.
+
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.
+
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).
+
Create a .travis.yml on the root of your repository with below text.
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.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Steps to configure your Docusaurus-powered site on Netlify.
+
+
Select New site from Git
+
Connect to your preferred Git provider.
+
Select the branch to deploy. Default is master
+
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)
+
+
Click Deploy site
+
+
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 deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Select the branch to deploy. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
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.
+
+
+
Name
说明
+
+
+
GITHUB_HOST
The hostname for the GitHub enterprise server.
+
+
+
Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.
\ No newline at end of file
diff --git a/docs/zh-CN/publishing/index.html b/docs/zh-CN/publishing/index.html
new file mode 100644
index 0000000000..c7b12525c9
--- /dev/null
+++ b/docs/zh-CN/publishing/index.html
@@ -0,0 +1,447 @@
+Publishing your site · Docusaurus
此时，您会在 website/build 目录中得到所有的文件，并将它们复制到您青睐的 Web 服务器的 html 目录中。
+
+
For example, both Apache and Nginx serve content from /var/www/html by default. 也就是说，选择 web 服务端或提供相应服务都超出了Docusaurus 的范围。
+
+
+
当您使用自己的 web 服务端时，请确保 web 服务端使用了合适的 HTTP headers 为静态资源文件提供服务。 CSS 文件 header 中的 content-type 应该是 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.
Run a single command inside the root directory of your project:
+
+
vercel
+
+
That's all. Your docs will automatically be deployed.
+
+
Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The docs directory has to be within the website directory, ideally following the directory structure in this example. You will also have to specify a customDocsPath value in siteConfig.js. Take a look at the now-examples repository for a Docusaurus project.
+
+
Using GitHub Pages
+
Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: GitHub Pages.
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).
+
+
You will need to modify the file website/siteConfig.js and add the required parameters.
+
+
+
+
Name
说明
+
+
+
organizationName
The 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.
+
projectName
The 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".
+
url
Your website's URL. For projects hosted on GitHub pages, this will be "https://username.github.io"
+
baseUrl
Base URL for your project. For projects hosted on GitHub pages, it follows the format "/projectName/". For https://github.com/facebook/docusaurus, baseUrl is /docusaurus/.
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.
+
+
+
Now you have to specify the git user as an environment variable, and run the script publish-gh-pages
+
+
+
+
Name
说明
+
+
+
GIT_USER
The username for a GitHub account that has to commit access to this repo. For your 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.
+
Bash
+
GIT_USER=<GIT_USER> \
+ CURRENT_BRANCH=master \
+ USE_SSH=true \
+ yarn run publish-gh-pages # or `npm run publish-gh-pages`
+
There are also two optional parameters that are set as environment variables:
+
+
+
Name
说明
+
+
+
USE_SSH
If 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_BRANCH
The 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.
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 cnamesiteConfig 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 the 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.
+
+
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.
+
Log into GitHub as the GIT_USER.
+
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.
+
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.
+
Create a new environment variable named GITHUB_TOKEN, using your newly generated access token as the value.
+
Create a .circleci directory and create a config.yml under that directory.
+
Copy the text below into .circleci/config.yml.
+
+
# If you only want the 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:DeployingtoGitHubPages
+ 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 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 your GitHub account, add the Travis CI app to the repository you want to activate.
+
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.
+
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).
+
Create a .travis.yml on the root of your repository with below text.
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.
In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add 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). Make sure to mark them as secret. Alternatively, you can also add a file named azure-pipelines.yml at yout repository root.
Click on the repository, click on activate repository, and add a secret called git_deploy_private_key with your private key value that you just generated.
+
Create a .drone.yml on the root of your repository with below text.
Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website.
+
Hosting on Vercel
+
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
+
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
+
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found here.
Steps to configure your Docusaurus-powered site on Netlify.
+
+
Select New site from Git
+
Connect to your preferred Git provider.
+
Select the branch to deploy. Default is master
+
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)
+
+
Click Deploy site
+
+
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 deploy from your Git repo. Deploy your app in just a few minutes by following these steps.
+
+
Create a new Web Service on Render, and give Render's GitHub app permission to access your Docusaurus repo.
+
Select the branch to deploy. The default is master.
+
Enter the following values during creation.
+
+
+
Field
Value
+
+
+
Environment
Static Site
+
Build Command
cd website; yarn install; yarn build
+
Publish Directory
website/build/<projectName>
+
+
+
projectName is the value you defined in your siteConfig.js.
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.
+
+
+
Name
说明
+
+
+
GITHUB_HOST
The hostname for the GitHub enterprise server.
+
+
+
Alter your siteConfig.js to add a property 'githubHost' which represents the GitHub Enterprise hostname. Alternatively, set an environment variable GITHUB_HOST when executing the publish command.
\ No newline at end of file
diff --git a/docs/zh-CN/search.html b/docs/zh-CN/search.html
new file mode 100644
index 0000000000..826aa42aae
--- /dev/null
+++ b/docs/zh-CN/search.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.
+
DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.
+
启用搜索框
+
Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Extra Search Options
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.
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.
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:
\ No newline at end of file
diff --git a/docs/zh-CN/search/index.html b/docs/zh-CN/search/index.html
new file mode 100644
index 0000000000..826aa42aae
--- /dev/null
+++ b/docs/zh-CN/search/index.html
@@ -0,0 +1,163 @@
+Enabling Search · Docusaurus
Docusaurus支持使用 Algolia DocSearch 来搜索你的网站。 Once your website is online, you can submit it to DocSearch. Algolia will then send you credentials you can add to your siteConfig.js.
+
DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free.
+
启用搜索框
+
Enter your API key and index name (sent by Algolia) into siteConfig.js in the algolia section to enable search for your site.
+
const siteConfig = {
+ ...
+ algolia: {
+ apiKey: 'my-api-key',
+ indexName: 'my-index-name',
+ appId: 'app-id', // Optional, if you run the DocSearch crawler on your own
+ algoliaOptions: {} // Optional, if provided by Algolia
+ },
+ ...
+};
+
+
Extra Search Options
+
You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. 如果您想为不同版本或语言的文档提供不同的搜索结果，这可能会很有用。 Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.
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.
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:
\ No newline at end of file
diff --git a/docs/zh-CN/site-config.html b/docs/zh-CN/site-config.html
new file mode 100644
index 0000000000..eb3d8b1b8b
--- /dev/null
+++ b/docs/zh-CN/site-config.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
数组users用于存储要在网站上显示的所有项目或用户信息。 Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。
+
Currently, this users array is used only by the index.js and users.js example files. 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。
+
siteConfig 属性
+
siteConfig 对象包含了网站的大部分配置。
+
必填属性
+
baseUrl [string]
+
baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. 对于没有路径的 URL，BaseUrl 应设置为 /。 This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor 标题导航栏和侧边栏的颜色。
+
secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
+
还可以添加自定义颜色。 For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
copyright [string]
+
The copyright string at the footer of the site and within the feed
+
favicon [string]
+
URL for site favicon.
+
headerIcon [string]
+
头部导航栏中使用图标的 URL。
+
headerLinks [array]
+
Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.
+
示例用法：
+
headerLinks: [
+ // Links to document with id doc1 for current language/version
+ { doc: "doc1", label: "Getting Started" },
+ // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
+ { page: "help", label: "Help" },
+ // Links to href destination, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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.
+
可选属性
+
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.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ No newline at end of file
diff --git a/docs/zh-CN/site-config/index.html b/docs/zh-CN/site-config/index.html
new file mode 100644
index 0000000000..eb3d8b1b8b
--- /dev/null
+++ b/docs/zh-CN/site-config/index.html
@@ -0,0 +1,433 @@
+siteConfig.js · Docusaurus
数组users用于存储要在网站上显示的所有项目或用户信息。 Currently, this field is used by the example pages/en/index.js and pages/en/users.js files provided. 每个user对象都包含有 caption、image、infoLink和 pinned 属性。 caption 是当有人悬停在该用户头像(image) 上时显示的文本, 而 infoLink 是点击头像后将要跳转的用户信息链接。 pinned 表示是否在首页固定显示。
+
Currently, this users array is used only by the index.js and users.js example files. 如果你不想要用户展示页面或不想在首页展示用户，你可以删除它。
+
siteConfig 属性
+
siteConfig 对象包含了网站的大部分配置。
+
必填属性
+
baseUrl [string]
+
baseUrl for your site. This can also be considered the path after the host. For example, /metro/ is the baseUrl of https://facebook.github.io/metro/. 对于没有路径的 URL，BaseUrl 应设置为 /。 This field is related to the url field.
+
colors [object]
+
Color configurations for the site.
+
+
primaryColor 标题导航栏和侧边栏的颜色。
+
secondaryColor 当网站窗口收缩 (包括手机) 时标题导航栏第二行中看到的颜色。
+
还可以添加自定义颜色。 For example, if user styles are added with colors specified as $myColor, then adding a myColor field to colors will allow you to configure this color.
+
+
copyright [string]
+
The copyright string at the footer of the site and within the feed
+
favicon [string]
+
URL for site favicon.
+
headerIcon [string]
+
头部导航栏中使用图标的 URL。
+
headerLinks [array]
+
Links that will be used in the header navigation bar. The label field of each object will be the link text and will also be translated for each language.
+
示例用法：
+
headerLinks: [
+ // Links to document with id doc1 for current language/version
+ { doc: "doc1", label: "Getting Started" },
+ // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language
+ { page: "help", label: "Help" },
+ // Links to href destination, using target=_blank (external)
+ { href: "https://github.com/", label: "GitHub", external: true },
+ // 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.
+
可选属性
+
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.
If users intend for this website to be used exclusively offline, this value must be set to false. Otherwise, it will cause the site to route to the parent folder of the linked page.
+
+
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.
+
deletedDocs [object]
+
Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to fallback functionality. This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not.
+
To force removal of content beginning with a certain version (including for current/next), add a deletedDocs object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions.
The version keys must match those in versions.json. Assuming the versions list in versions.json is ["3.0.0", "2.0.0", "1.1.0", "1.0.0"], the docs/1.0.0/tagging and docs/1.1.0/tagging URLs will work but docs/2.0.0/tagging, docs/3.0.0/tagging, and docs/tagging will not. The files and folders for those versions will not be generated during the build.
+
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.
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.
{
+ // ...
+ 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.
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:
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:
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.
+
slugPreprocessor [function]
+
Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string.
+
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.
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.
+
Adding Google Fonts
+
+
Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the Google Fonts documentation.
+
To add Google Fonts to your Docusaurus deployment, add the font path to the siteConfig.js under stylesheets:
\ No newline at end of file
diff --git a/docs/zh-CN/tutorial-create-pages.html b/docs/zh-CN/tutorial-create-pages.html
new file mode 100644
index 0000000000..b5585fbe41
--- /dev/null
+++ b/docs/zh-CN/tutorial-create-pages.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/zh-CN/tutorial-create-pages/index.html b/docs/zh-CN/tutorial-create-pages/index.html
new file mode 100644
index 0000000000..b5585fbe41
--- /dev/null
+++ b/docs/zh-CN/tutorial-create-pages/index.html
@@ -0,0 +1,191 @@
+Create Pages · Docusaurus
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.
+
+
- <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.
+
+
Create a Documentation Page
+
+
Create a new file in the docs folder called doc9.md. The docs folder is in the root of your Docusaurus project, same level as the website folder.
+
Paste the following contents:
+
+
---
+id: doc9
+title: This is Doc 9
+---
+
+I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
+
+## Markdown Syntax
+
+**Bold**_italic_`code` [Links](#url)
+
+> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
+> id sem consectetuer libero luctus adipiscing.
+
+* Hey
+* Ho
+* Let's Go
+
+
+
The sidebars.json is where you specify the order of your documentation pages, so open website/sidebars.json and add "doc9" 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.
A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run npm start or yarn start.
\ No newline at end of file
diff --git a/docs/zh-CN/tutorial-version.html b/docs/zh-CN/tutorial-version.html
new file mode 100644
index 0000000000..e48f5efe90
--- /dev/null
+++ b/docs/zh-CN/tutorial-version.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
下一个版本
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
总结
+
都在这儿了！ In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. 您可以在 Docusaurus 上做更多的事情，例如添加博客、搜索和翻译。 Check out the Guides section for more.
\ No newline at end of file
diff --git a/docs/zh-CN/tutorial-version/index.html b/docs/zh-CN/tutorial-version/index.html
new file mode 100644
index 0000000000..e48f5efe90
--- /dev/null
+++ b/docs/zh-CN/tutorial-version/index.html
@@ -0,0 +1,147 @@
+Add Versions · Docusaurus
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 for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes.
+
+
Releasing a Version
+
Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you cd to the website directory and run the following command.
+
npm run examples versions
+
+
That command generates a versions.json file, which will be used to list down all the versions of docs in the project.
+
Next, you run a command with the version you want to create, like 1.0.0.
+
npm run version 1.0.0
+
+
That command preserves a copy of all documents currently in the docs directory and makes them available as documentation for version 1.0.0. The docs directory is copied to the website/versioned_docs/version-1.0.0 directory.
Let's test out how versioning actually works. Open 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 you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version.
+
下一个版本
+
The latest version of the documents is viewed by adding next to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL.
+
Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both 1.0.0 and master are listed there and they link to the respective versions of the documentation.
+
The master documents in the docs directory became version next when the website/versioned_docs/version-1.0.0 directory was made for version 1.0.0.
+
Past Versions
+
Assume the documentation changed and needs an update. You can release another version, like 1.0.1.
Go ahead and publish your versioned site with the publish-gh-pages script!
+
总结
+
都在这儿了！ In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. 您可以在 Docusaurus 上做更多的事情，例如添加博客、搜索和翻译。 Check out the Guides section for more.
