From d2cf4a28d4de703c5c4e9006004c03917d7b274b Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Sun, 3 Nov 2019 15:31:08 +0000 Subject: [PATCH] Deploy website Deploy website version based on 2d13fe2e0fb6a87485b384e8901b74f32870fcc5 --- css/main.css | 2 +- docs/en/1.10.x/adding-blog.html | 2 +- docs/en/1.10.x/adding-blog/index.html | 2 +- docs/en/1.10.x/doc-markdown.html | 4 +- docs/en/1.10.x/doc-markdown/index.html | 4 +- docs/en/1.10.x/docker.html | 30 +++---- docs/en/1.10.x/docker/index.html | 30 +++---- docs/en/1.10.x/publishing.html | 60 ++++++------- docs/en/1.10.x/publishing/index.html | 60 ++++++------- docs/en/1.10.x/site-config.html | 16 ++-- docs/en/1.10.x/site-config/index.html | 16 ++-- docs/en/1.10.x/translation.html | 64 ++++++------- docs/en/1.10.x/translation/index.html | 64 ++++++------- docs/en/1.10.x/tutorial-publish-site.html | 6 +- .../1.10.x/tutorial-publish-site/index.html | 6 +- docs/en/1.11.x/adding-blog.html | 2 +- docs/en/1.11.x/adding-blog/index.html | 2 +- docs/en/1.11.x/doc-markdown.html | 4 +- docs/en/1.11.x/doc-markdown/index.html | 4 +- docs/en/1.11.x/docker.html | 30 +++---- docs/en/1.11.x/docker/index.html | 30 +++---- docs/en/1.11.x/publishing.html | 60 ++++++------- docs/en/1.11.x/publishing/index.html | 60 ++++++------- docs/en/1.11.x/site-config.html | 16 ++-- docs/en/1.11.x/site-config/index.html | 16 ++-- docs/en/1.11.x/translation.html | 64 ++++++------- docs/en/1.11.x/translation/index.html | 64 ++++++------- docs/en/1.11.x/tutorial-publish-site.html | 6 +- .../1.11.x/tutorial-publish-site/index.html | 6 +- docs/en/1.12.0/adding-blog.html | 2 +- docs/en/1.12.0/adding-blog/index.html | 2 +- docs/en/1.12.0/doc-markdown.html | 4 +- docs/en/1.12.0/doc-markdown/index.html | 4 +- docs/en/1.12.0/docker.html | 30 +++---- docs/en/1.12.0/docker/index.html | 30 +++---- docs/en/1.12.0/publishing.html | 60 ++++++------- docs/en/1.12.0/publishing/index.html | 60 ++++++------- docs/en/1.12.0/site-config.html | 16 ++-- docs/en/1.12.0/site-config/index.html | 16 ++-- docs/en/1.12.0/translation.html | 64 ++++++------- docs/en/1.12.0/translation/index.html | 64 ++++++------- docs/en/1.12.0/tutorial-publish-site.html | 6 +- .../1.12.0/tutorial-publish-site/index.html | 6 +- docs/en/1.13.0/adding-blog.html | 2 +- docs/en/1.13.0/adding-blog/index.html | 2 +- docs/en/1.13.0/doc-markdown.html | 4 +- docs/en/1.13.0/doc-markdown/index.html | 4 +- docs/en/1.13.0/docker.html | 30 +++---- docs/en/1.13.0/docker/index.html | 30 +++---- docs/en/1.13.0/publishing.html | 60 ++++++------- docs/en/1.13.0/publishing/index.html | 60 ++++++------- docs/en/1.13.0/site-config.html | 16 ++-- docs/en/1.13.0/site-config/index.html | 16 ++-- docs/en/1.13.0/translation.html | 64 ++++++------- docs/en/1.13.0/translation/index.html | 64 ++++++------- docs/en/1.13.0/tutorial-publish-site.html | 6 +- .../1.13.0/tutorial-publish-site/index.html | 6 +- docs/en/1.9.x/adding-blog.html | 2 +- docs/en/1.9.x/adding-blog/index.html | 2 +- docs/en/1.9.x/doc-markdown.html | 4 +- docs/en/1.9.x/doc-markdown/index.html | 4 +- docs/en/1.9.x/docker.html | 30 +++---- docs/en/1.9.x/docker/index.html | 30 +++---- docs/en/1.9.x/publishing.html | 60 ++++++------- docs/en/1.9.x/publishing/index.html | 60 ++++++------- docs/en/1.9.x/site-config.html | 16 ++-- docs/en/1.9.x/site-config/index.html | 16 ++-- docs/en/1.9.x/translation.html | 64 ++++++------- docs/en/1.9.x/translation/index.html | 64 ++++++------- docs/en/1.9.x/tutorial-publish-site.html | 6 +- .../en/1.9.x/tutorial-publish-site/index.html | 6 +- docs/en/adding-blog.html | 2 +- docs/en/adding-blog/index.html | 2 +- docs/en/doc-markdown.html | 4 +- docs/en/doc-markdown/index.html | 4 +- docs/en/docker.html | 30 +++---- docs/en/docker/index.html | 30 +++---- docs/en/next/adding-blog.html | 2 +- docs/en/next/adding-blog/index.html | 2 +- docs/en/next/doc-markdown.html | 4 +- docs/en/next/doc-markdown/index.html | 4 +- docs/en/next/docker.html | 30 +++---- docs/en/next/docker/index.html | 30 +++---- docs/en/next/publishing.html | 60 ++++++------- docs/en/next/publishing/index.html | 60 ++++++------- docs/en/next/site-config.html | 16 ++-- docs/en/next/site-config/index.html | 16 ++-- docs/en/next/translation.html | 64 ++++++------- docs/en/next/translation/index.html | 64 ++++++------- docs/en/next/tutorial-publish-site.html | 6 +- docs/en/next/tutorial-publish-site/index.html | 6 +- docs/en/publishing.html | 60 ++++++------- docs/en/publishing/index.html | 60 ++++++------- docs/en/site-config.html | 16 ++-- docs/en/site-config/index.html | 16 ++-- docs/en/translation.html | 64 ++++++------- docs/en/translation/index.html | 64 ++++++------- docs/en/tutorial-publish-site.html | 6 +- docs/en/tutorial-publish-site/index.html | 6 +- docs/fr/1.10.x/adding-blog.html | 2 +- docs/fr/1.10.x/adding-blog/index.html | 2 +- docs/fr/1.10.x/doc-markdown.html | 10 +-- docs/fr/1.10.x/doc-markdown/index.html | 10 +-- docs/fr/1.10.x/docker.html | 30 +++---- docs/fr/1.10.x/docker/index.html | 30 +++---- docs/fr/1.10.x/publishing.html | 60 ++++++------- docs/fr/1.10.x/publishing/index.html | 60 ++++++------- docs/fr/1.10.x/site-config.html | 16 ++-- docs/fr/1.10.x/site-config/index.html | 16 ++-- docs/fr/1.10.x/translation.html | 64 ++++++------- docs/fr/1.10.x/translation/index.html | 64 ++++++------- docs/fr/1.11.x/adding-blog.html | 2 +- docs/fr/1.11.x/adding-blog/index.html | 2 +- docs/fr/1.11.x/doc-markdown.html | 10 +-- docs/fr/1.11.x/doc-markdown/index.html | 10 +-- docs/fr/1.11.x/docker.html | 30 +++---- docs/fr/1.11.x/docker/index.html | 30 +++---- docs/fr/1.11.x/publishing.html | 60 ++++++------- docs/fr/1.11.x/publishing/index.html | 60 ++++++------- docs/fr/1.11.x/site-config.html | 16 ++-- docs/fr/1.11.x/site-config/index.html | 16 ++-- docs/fr/1.11.x/translation.html | 64 ++++++------- docs/fr/1.11.x/translation/index.html | 64 ++++++------- docs/fr/1.12.0/adding-blog.html | 2 +- docs/fr/1.12.0/adding-blog/index.html | 2 +- docs/fr/1.12.0/doc-markdown.html | 10 +-- docs/fr/1.12.0/doc-markdown/index.html | 10 +-- docs/fr/1.12.0/docker.html | 30 +++---- docs/fr/1.12.0/docker/index.html | 30 +++---- docs/fr/1.12.0/publishing.html | 60 ++++++------- docs/fr/1.12.0/publishing/index.html | 60 ++++++------- docs/fr/1.12.0/site-config.html | 16 ++-- docs/fr/1.12.0/site-config/index.html | 16 ++-- docs/fr/1.12.0/translation.html | 64 ++++++------- docs/fr/1.12.0/translation/index.html | 64 ++++++------- docs/fr/1.13.0/adding-blog.html | 2 +- docs/fr/1.13.0/adding-blog/index.html | 2 +- docs/fr/1.13.0/doc-markdown.html | 10 +-- docs/fr/1.13.0/doc-markdown/index.html | 10 +-- docs/fr/1.13.0/docker.html | 30 +++---- docs/fr/1.13.0/docker/index.html | 30 +++---- docs/fr/1.13.0/publishing.html | 60 ++++++------- docs/fr/1.13.0/publishing/index.html | 60 ++++++------- docs/fr/1.13.0/site-config.html | 16 ++-- docs/fr/1.13.0/site-config/index.html | 16 ++-- docs/fr/1.13.0/translation.html | 64 ++++++------- docs/fr/1.13.0/translation/index.html | 64 ++++++------- docs/fr/1.9.x/adding-blog.html | 2 +- docs/fr/1.9.x/adding-blog/index.html | 2 +- docs/fr/1.9.x/doc-markdown.html | 10 +-- docs/fr/1.9.x/doc-markdown/index.html | 10 +-- docs/fr/1.9.x/docker.html | 30 +++---- docs/fr/1.9.x/docker/index.html | 30 +++---- docs/fr/1.9.x/publishing.html | 60 ++++++------- docs/fr/1.9.x/publishing/index.html | 60 ++++++------- docs/fr/1.9.x/site-config.html | 16 ++-- docs/fr/1.9.x/site-config/index.html | 16 ++-- docs/fr/1.9.x/translation.html | 64 ++++++------- docs/fr/1.9.x/translation/index.html | 64 ++++++------- docs/fr/adding-blog.html | 2 +- docs/fr/adding-blog/index.html | 2 +- docs/fr/doc-markdown.html | 10 +-- docs/fr/doc-markdown/index.html | 10 +-- docs/fr/docker.html | 30 +++---- docs/fr/docker/index.html | 30 +++---- docs/fr/next/adding-blog.html | 2 +- docs/fr/next/adding-blog/index.html | 2 +- docs/fr/next/doc-markdown.html | 10 +-- docs/fr/next/doc-markdown/index.html | 10 +-- docs/fr/next/docker.html | 30 +++---- docs/fr/next/docker/index.html | 30 +++---- docs/fr/next/publishing.html | 60 ++++++------- docs/fr/next/publishing/index.html | 60 ++++++------- docs/fr/next/site-config.html | 16 ++-- docs/fr/next/site-config/index.html | 16 ++-- docs/fr/next/translation.html | 64 ++++++------- docs/fr/next/translation/index.html | 64 ++++++------- docs/fr/publishing.html | 60 ++++++------- docs/fr/publishing/index.html | 60 ++++++------- docs/fr/site-config.html | 16 ++-- docs/fr/site-config/index.html | 16 ++-- docs/fr/translation.html | 64 ++++++------- docs/fr/translation/index.html | 64 ++++++------- docs/ko/1.10.x/adding-blog.html | 2 +- docs/ko/1.10.x/adding-blog/index.html | 2 +- docs/ko/1.10.x/doc-markdown.html | 4 +- docs/ko/1.10.x/doc-markdown/index.html | 4 +- docs/ko/1.10.x/docker.html | 30 +++---- docs/ko/1.10.x/docker/index.html | 30 +++---- docs/ko/1.10.x/publishing.html | 60 ++++++------- docs/ko/1.10.x/publishing/index.html | 60 ++++++------- docs/ko/1.10.x/site-config.html | 16 ++-- docs/ko/1.10.x/site-config/index.html | 16 ++-- docs/ko/1.10.x/translation.html | 64 ++++++------- docs/ko/1.10.x/translation/index.html | 64 ++++++------- docs/ko/1.11.x/adding-blog.html | 2 +- docs/ko/1.11.x/adding-blog/index.html | 2 +- docs/ko/1.11.x/doc-markdown.html | 4 +- docs/ko/1.11.x/doc-markdown/index.html | 4 +- docs/ko/1.11.x/docker.html | 30 +++---- docs/ko/1.11.x/docker/index.html | 30 +++---- docs/ko/1.11.x/publishing.html | 60 ++++++------- docs/ko/1.11.x/publishing/index.html | 60 ++++++------- docs/ko/1.11.x/site-config.html | 16 ++-- docs/ko/1.11.x/site-config/index.html | 16 ++-- docs/ko/1.11.x/translation.html | 64 ++++++------- docs/ko/1.11.x/translation/index.html | 64 ++++++------- docs/ko/1.12.0/adding-blog.html | 2 +- docs/ko/1.12.0/adding-blog/index.html | 2 +- docs/ko/1.12.0/doc-markdown.html | 4 +- docs/ko/1.12.0/doc-markdown/index.html | 4 +- docs/ko/1.12.0/docker.html | 30 +++---- docs/ko/1.12.0/docker/index.html | 30 +++---- docs/ko/1.12.0/publishing.html | 60 ++++++------- docs/ko/1.12.0/publishing/index.html | 60 ++++++------- docs/ko/1.12.0/site-config.html | 16 ++-- docs/ko/1.12.0/site-config/index.html | 16 ++-- docs/ko/1.12.0/translation.html | 64 ++++++------- docs/ko/1.12.0/translation/index.html | 64 ++++++------- docs/ko/1.13.0/adding-blog.html | 2 +- docs/ko/1.13.0/adding-blog/index.html | 2 +- docs/ko/1.13.0/doc-markdown.html | 4 +- docs/ko/1.13.0/doc-markdown/index.html | 4 +- docs/ko/1.13.0/docker.html | 30 +++---- docs/ko/1.13.0/docker/index.html | 30 +++---- docs/ko/1.13.0/publishing.html | 60 ++++++------- docs/ko/1.13.0/publishing/index.html | 60 ++++++------- docs/ko/1.13.0/site-config.html | 16 ++-- docs/ko/1.13.0/site-config/index.html | 16 ++-- docs/ko/1.13.0/translation.html | 64 ++++++------- docs/ko/1.13.0/translation/index.html | 64 ++++++------- docs/ko/1.9.x/adding-blog.html | 2 +- docs/ko/1.9.x/adding-blog/index.html | 2 +- docs/ko/1.9.x/doc-markdown.html | 4 +- docs/ko/1.9.x/doc-markdown/index.html | 4 +- docs/ko/1.9.x/docker.html | 30 +++---- docs/ko/1.9.x/docker/index.html | 30 +++---- docs/ko/1.9.x/publishing.html | 60 ++++++------- docs/ko/1.9.x/publishing/index.html | 60 ++++++------- docs/ko/1.9.x/site-config.html | 16 ++-- docs/ko/1.9.x/site-config/index.html | 16 ++-- docs/ko/1.9.x/translation.html | 64 ++++++------- docs/ko/1.9.x/translation/index.html | 64 ++++++------- docs/ko/adding-blog.html | 2 +- docs/ko/adding-blog/index.html | 2 +- docs/ko/doc-markdown.html | 4 +- docs/ko/doc-markdown/index.html | 4 +- docs/ko/docker.html | 30 +++---- docs/ko/docker/index.html | 30 +++---- docs/ko/next/adding-blog.html | 2 +- docs/ko/next/adding-blog/index.html | 2 +- docs/ko/next/doc-markdown.html | 4 +- docs/ko/next/doc-markdown/index.html | 4 +- docs/ko/next/docker.html | 30 +++---- docs/ko/next/docker/index.html | 30 +++---- docs/ko/next/publishing.html | 60 ++++++------- docs/ko/next/publishing/index.html | 60 ++++++------- docs/ko/next/site-config.html | 16 ++-- docs/ko/next/site-config/index.html | 16 ++-- docs/ko/next/translation.html | 64 ++++++------- docs/ko/next/translation/index.html | 64 ++++++------- docs/ko/publishing.html | 60 ++++++------- docs/ko/publishing/index.html | 60 ++++++------- docs/ko/site-config.html | 16 ++-- docs/ko/site-config/index.html | 16 ++-- docs/ko/translation.html | 64 ++++++------- docs/ko/translation/index.html | 64 ++++++------- docs/pt-BR/1.10.x/adding-blog.html | 2 +- docs/pt-BR/1.10.x/adding-blog/index.html | 2 +- docs/pt-BR/1.10.x/doc-markdown.html | 4 +- docs/pt-BR/1.10.x/doc-markdown/index.html | 4 +- docs/pt-BR/1.10.x/docker.html | 30 +++---- docs/pt-BR/1.10.x/docker/index.html | 30 +++---- docs/pt-BR/1.10.x/publishing.html | 60 ++++++------- docs/pt-BR/1.10.x/publishing/index.html | 60 ++++++------- docs/pt-BR/1.10.x/site-config.html | 16 ++-- docs/pt-BR/1.10.x/site-config/index.html | 16 ++-- docs/pt-BR/1.10.x/translation.html | 90 +++++++++---------- docs/pt-BR/1.10.x/translation/index.html | 90 +++++++++---------- docs/pt-BR/1.11.x/adding-blog.html | 2 +- docs/pt-BR/1.11.x/adding-blog/index.html | 2 +- docs/pt-BR/1.11.x/doc-markdown.html | 4 +- docs/pt-BR/1.11.x/doc-markdown/index.html | 4 +- docs/pt-BR/1.11.x/docker.html | 30 +++---- docs/pt-BR/1.11.x/docker/index.html | 30 +++---- docs/pt-BR/1.11.x/publishing.html | 60 ++++++------- docs/pt-BR/1.11.x/publishing/index.html | 60 ++++++------- docs/pt-BR/1.11.x/site-config.html | 16 ++-- docs/pt-BR/1.11.x/site-config/index.html | 16 ++-- docs/pt-BR/1.11.x/translation.html | 90 +++++++++---------- docs/pt-BR/1.11.x/translation/index.html | 90 +++++++++---------- docs/pt-BR/1.12.0/adding-blog.html | 2 +- docs/pt-BR/1.12.0/adding-blog/index.html | 2 +- docs/pt-BR/1.12.0/doc-markdown.html | 4 +- docs/pt-BR/1.12.0/doc-markdown/index.html | 4 +- docs/pt-BR/1.12.0/docker.html | 30 +++---- docs/pt-BR/1.12.0/docker/index.html | 30 +++---- docs/pt-BR/1.12.0/publishing.html | 60 ++++++------- docs/pt-BR/1.12.0/publishing/index.html | 60 ++++++------- docs/pt-BR/1.12.0/site-config.html | 16 ++-- docs/pt-BR/1.12.0/site-config/index.html | 16 ++-- docs/pt-BR/1.12.0/translation.html | 90 +++++++++---------- docs/pt-BR/1.12.0/translation/index.html | 90 +++++++++---------- docs/pt-BR/1.13.0/adding-blog.html | 2 +- docs/pt-BR/1.13.0/adding-blog/index.html | 2 +- docs/pt-BR/1.13.0/doc-markdown.html | 4 +- docs/pt-BR/1.13.0/doc-markdown/index.html | 4 +- docs/pt-BR/1.13.0/docker.html | 30 +++---- docs/pt-BR/1.13.0/docker/index.html | 30 +++---- docs/pt-BR/1.13.0/publishing.html | 60 ++++++------- docs/pt-BR/1.13.0/publishing/index.html | 60 ++++++------- docs/pt-BR/1.13.0/site-config.html | 16 ++-- docs/pt-BR/1.13.0/site-config/index.html | 16 ++-- docs/pt-BR/1.13.0/translation.html | 90 +++++++++---------- docs/pt-BR/1.13.0/translation/index.html | 90 +++++++++---------- docs/pt-BR/1.9.x/adding-blog.html | 2 +- docs/pt-BR/1.9.x/adding-blog/index.html | 2 +- docs/pt-BR/1.9.x/doc-markdown.html | 4 +- docs/pt-BR/1.9.x/doc-markdown/index.html | 4 +- docs/pt-BR/1.9.x/docker.html | 30 +++---- docs/pt-BR/1.9.x/docker/index.html | 30 +++---- docs/pt-BR/1.9.x/publishing.html | 60 ++++++------- docs/pt-BR/1.9.x/publishing/index.html | 60 ++++++------- docs/pt-BR/1.9.x/site-config.html | 16 ++-- docs/pt-BR/1.9.x/site-config/index.html | 16 ++-- docs/pt-BR/1.9.x/translation.html | 90 +++++++++---------- docs/pt-BR/1.9.x/translation/index.html | 90 +++++++++---------- docs/pt-BR/adding-blog.html | 2 +- docs/pt-BR/adding-blog/index.html | 2 +- docs/pt-BR/doc-markdown.html | 4 +- docs/pt-BR/doc-markdown/index.html | 4 +- docs/pt-BR/docker.html | 30 +++---- docs/pt-BR/docker/index.html | 30 +++---- docs/pt-BR/next/adding-blog.html | 2 +- docs/pt-BR/next/adding-blog/index.html | 2 +- docs/pt-BR/next/doc-markdown.html | 4 +- docs/pt-BR/next/doc-markdown/index.html | 4 +- docs/pt-BR/next/docker.html | 30 +++---- docs/pt-BR/next/docker/index.html | 30 +++---- docs/pt-BR/next/publishing.html | 60 ++++++------- docs/pt-BR/next/publishing/index.html | 60 ++++++------- docs/pt-BR/next/site-config.html | 16 ++-- docs/pt-BR/next/site-config/index.html | 16 ++-- docs/pt-BR/next/translation.html | 90 +++++++++---------- docs/pt-BR/next/translation/index.html | 90 +++++++++---------- docs/pt-BR/publishing.html | 60 ++++++------- docs/pt-BR/publishing/index.html | 60 ++++++------- docs/pt-BR/site-config.html | 16 ++-- docs/pt-BR/site-config/index.html | 16 ++-- docs/pt-BR/translation.html | 90 +++++++++---------- docs/pt-BR/translation/index.html | 90 +++++++++---------- docs/ro/1.10.x/adding-blog.html | 2 +- docs/ro/1.10.x/adding-blog/index.html | 2 +- docs/ro/1.10.x/doc-markdown.html | 4 +- docs/ro/1.10.x/doc-markdown/index.html | 4 +- docs/ro/1.10.x/docker.html | 30 +++---- docs/ro/1.10.x/docker/index.html | 30 +++---- docs/ro/1.10.x/publishing.html | 60 ++++++------- docs/ro/1.10.x/publishing/index.html | 60 ++++++------- docs/ro/1.10.x/site-config.html | 16 ++-- docs/ro/1.10.x/site-config/index.html | 16 ++-- docs/ro/1.10.x/translation.html | 62 ++++++------- docs/ro/1.10.x/translation/index.html | 62 ++++++------- docs/ro/1.11.x/adding-blog.html | 2 +- docs/ro/1.11.x/adding-blog/index.html | 2 +- docs/ro/1.11.x/doc-markdown.html | 4 +- docs/ro/1.11.x/doc-markdown/index.html | 4 +- docs/ro/1.11.x/docker.html | 30 +++---- docs/ro/1.11.x/docker/index.html | 30 +++---- docs/ro/1.11.x/publishing.html | 60 ++++++------- docs/ro/1.11.x/publishing/index.html | 60 ++++++------- docs/ro/1.11.x/site-config.html | 16 ++-- docs/ro/1.11.x/site-config/index.html | 16 ++-- docs/ro/1.11.x/translation.html | 62 ++++++------- docs/ro/1.11.x/translation/index.html | 62 ++++++------- docs/ro/1.12.0/adding-blog.html | 2 +- docs/ro/1.12.0/adding-blog/index.html | 2 +- docs/ro/1.12.0/doc-markdown.html | 4 +- docs/ro/1.12.0/doc-markdown/index.html | 4 +- docs/ro/1.12.0/docker.html | 30 +++---- docs/ro/1.12.0/docker/index.html | 30 +++---- docs/ro/1.12.0/publishing.html | 60 ++++++------- docs/ro/1.12.0/publishing/index.html | 60 ++++++------- docs/ro/1.12.0/site-config.html | 16 ++-- docs/ro/1.12.0/site-config/index.html | 16 ++-- docs/ro/1.12.0/translation.html | 62 ++++++------- docs/ro/1.12.0/translation/index.html | 62 ++++++------- docs/ro/1.13.0/adding-blog.html | 2 +- docs/ro/1.13.0/adding-blog/index.html | 2 +- docs/ro/1.13.0/doc-markdown.html | 4 +- docs/ro/1.13.0/doc-markdown/index.html | 4 +- docs/ro/1.13.0/docker.html | 30 +++---- docs/ro/1.13.0/docker/index.html | 30 +++---- docs/ro/1.13.0/publishing.html | 60 ++++++------- docs/ro/1.13.0/publishing/index.html | 60 ++++++------- docs/ro/1.13.0/site-config.html | 16 ++-- docs/ro/1.13.0/site-config/index.html | 16 ++-- docs/ro/1.13.0/translation.html | 62 ++++++------- docs/ro/1.13.0/translation/index.html | 62 ++++++------- docs/ro/1.9.x/adding-blog.html | 2 +- docs/ro/1.9.x/adding-blog/index.html | 2 +- docs/ro/1.9.x/doc-markdown.html | 4 +- docs/ro/1.9.x/doc-markdown/index.html | 4 +- docs/ro/1.9.x/docker.html | 30 +++---- docs/ro/1.9.x/docker/index.html | 30 +++---- docs/ro/1.9.x/publishing.html | 60 ++++++------- docs/ro/1.9.x/publishing/index.html | 60 ++++++------- docs/ro/1.9.x/site-config.html | 16 ++-- docs/ro/1.9.x/site-config/index.html | 16 ++-- docs/ro/1.9.x/translation.html | 62 ++++++------- docs/ro/1.9.x/translation/index.html | 62 ++++++------- docs/ro/adding-blog.html | 2 +- docs/ro/adding-blog/index.html | 2 +- docs/ro/doc-markdown.html | 4 +- docs/ro/doc-markdown/index.html | 4 +- docs/ro/docker.html | 30 +++---- docs/ro/docker/index.html | 30 +++---- docs/ro/next/adding-blog.html | 2 +- docs/ro/next/adding-blog/index.html | 2 +- docs/ro/next/doc-markdown.html | 4 +- docs/ro/next/doc-markdown/index.html | 4 +- docs/ro/next/docker.html | 30 +++---- docs/ro/next/docker/index.html | 30 +++---- docs/ro/next/publishing.html | 60 ++++++------- docs/ro/next/publishing/index.html | 60 ++++++------- docs/ro/next/site-config.html | 16 ++-- docs/ro/next/site-config/index.html | 16 ++-- docs/ro/next/translation.html | 62 ++++++------- docs/ro/next/translation/index.html | 62 ++++++------- docs/ro/publishing.html | 60 ++++++------- docs/ro/publishing/index.html | 60 ++++++------- docs/ro/site-config.html | 16 ++-- docs/ro/site-config/index.html | 16 ++-- docs/ro/translation.html | 62 ++++++------- docs/ro/translation/index.html | 62 ++++++------- docs/ru/1.10.x/adding-blog.html | 2 +- docs/ru/1.10.x/adding-blog/index.html | 2 +- docs/ru/1.10.x/doc-markdown.html | 4 +- docs/ru/1.10.x/doc-markdown/index.html | 4 +- docs/ru/1.10.x/docker.html | 30 +++---- docs/ru/1.10.x/docker/index.html | 30 +++---- docs/ru/1.10.x/publishing.html | 60 ++++++------- docs/ru/1.10.x/publishing/index.html | 60 ++++++------- docs/ru/1.10.x/site-config.html | 16 ++-- docs/ru/1.10.x/site-config/index.html | 16 ++-- docs/ru/1.10.x/translation.html | 64 ++++++------- docs/ru/1.10.x/translation/index.html | 64 ++++++------- docs/ru/1.11.x/adding-blog.html | 2 +- docs/ru/1.11.x/adding-blog/index.html | 2 +- docs/ru/1.11.x/doc-markdown.html | 4 +- docs/ru/1.11.x/doc-markdown/index.html | 4 +- docs/ru/1.11.x/docker.html | 30 +++---- docs/ru/1.11.x/docker/index.html | 30 +++---- docs/ru/1.11.x/publishing.html | 60 ++++++------- docs/ru/1.11.x/publishing/index.html | 60 ++++++------- docs/ru/1.11.x/site-config.html | 16 ++-- docs/ru/1.11.x/site-config/index.html | 16 ++-- docs/ru/1.11.x/translation.html | 64 ++++++------- docs/ru/1.11.x/translation/index.html | 64 ++++++------- docs/ru/1.12.0/adding-blog.html | 2 +- docs/ru/1.12.0/adding-blog/index.html | 2 +- docs/ru/1.12.0/doc-markdown.html | 4 +- docs/ru/1.12.0/doc-markdown/index.html | 4 +- docs/ru/1.12.0/docker.html | 30 +++---- docs/ru/1.12.0/docker/index.html | 30 +++---- docs/ru/1.12.0/publishing.html | 60 ++++++------- docs/ru/1.12.0/publishing/index.html | 60 ++++++------- docs/ru/1.12.0/site-config.html | 16 ++-- docs/ru/1.12.0/site-config/index.html | 16 ++-- docs/ru/1.12.0/translation.html | 64 ++++++------- docs/ru/1.12.0/translation/index.html | 64 ++++++------- docs/ru/1.13.0/adding-blog.html | 2 +- docs/ru/1.13.0/adding-blog/index.html | 2 +- docs/ru/1.13.0/doc-markdown.html | 4 +- docs/ru/1.13.0/doc-markdown/index.html | 4 +- docs/ru/1.13.0/docker.html | 30 +++---- docs/ru/1.13.0/docker/index.html | 30 +++---- docs/ru/1.13.0/publishing.html | 60 ++++++------- docs/ru/1.13.0/publishing/index.html | 60 ++++++------- docs/ru/1.13.0/site-config.html | 16 ++-- docs/ru/1.13.0/site-config/index.html | 16 ++-- docs/ru/1.13.0/translation.html | 64 ++++++------- docs/ru/1.13.0/translation/index.html | 64 ++++++------- docs/ru/1.9.x/adding-blog.html | 2 +- docs/ru/1.9.x/adding-blog/index.html | 2 +- docs/ru/1.9.x/doc-markdown.html | 4 +- docs/ru/1.9.x/doc-markdown/index.html | 4 +- docs/ru/1.9.x/docker.html | 30 +++---- docs/ru/1.9.x/docker/index.html | 30 +++---- docs/ru/1.9.x/publishing.html | 60 ++++++------- docs/ru/1.9.x/publishing/index.html | 60 ++++++------- docs/ru/1.9.x/site-config.html | 16 ++-- docs/ru/1.9.x/site-config/index.html | 16 ++-- docs/ru/1.9.x/translation.html | 64 ++++++------- docs/ru/1.9.x/translation/index.html | 64 ++++++------- docs/ru/adding-blog.html | 2 +- docs/ru/adding-blog/index.html | 2 +- docs/ru/doc-markdown.html | 4 +- docs/ru/doc-markdown/index.html | 4 +- docs/ru/docker.html | 30 +++---- docs/ru/docker/index.html | 30 +++---- docs/ru/next/adding-blog.html | 2 +- docs/ru/next/adding-blog/index.html | 2 +- docs/ru/next/doc-markdown.html | 4 +- docs/ru/next/doc-markdown/index.html | 4 +- docs/ru/next/docker.html | 30 +++---- docs/ru/next/docker/index.html | 30 +++---- docs/ru/next/publishing.html | 60 ++++++------- docs/ru/next/publishing/index.html | 60 ++++++------- docs/ru/next/site-config.html | 16 ++-- docs/ru/next/site-config/index.html | 16 ++-- docs/ru/next/translation.html | 64 ++++++------- docs/ru/next/translation/index.html | 64 ++++++------- docs/ru/publishing.html | 60 ++++++------- docs/ru/publishing/index.html | 60 ++++++------- docs/ru/site-config.html | 16 ++-- docs/ru/site-config/index.html | 16 ++-- docs/ru/translation.html | 64 ++++++------- docs/ru/translation/index.html | 64 ++++++------- docs/zh-CN/1.10.x/adding-blog.html | 2 +- docs/zh-CN/1.10.x/adding-blog/index.html | 2 +- docs/zh-CN/1.10.x/doc-markdown.html | 4 +- docs/zh-CN/1.10.x/doc-markdown/index.html | 4 +- docs/zh-CN/1.10.x/docker.html | 30 +++---- docs/zh-CN/1.10.x/docker/index.html | 30 +++---- docs/zh-CN/1.10.x/publishing.html | 60 ++++++------- docs/zh-CN/1.10.x/publishing/index.html | 60 ++++++------- docs/zh-CN/1.10.x/site-config.html | 16 ++-- docs/zh-CN/1.10.x/site-config/index.html | 16 ++-- docs/zh-CN/1.10.x/translation.html | 64 ++++++------- docs/zh-CN/1.10.x/translation/index.html | 64 ++++++------- docs/zh-CN/1.11.x/adding-blog.html | 2 +- docs/zh-CN/1.11.x/adding-blog/index.html | 2 +- docs/zh-CN/1.11.x/doc-markdown.html | 4 +- docs/zh-CN/1.11.x/doc-markdown/index.html | 4 +- docs/zh-CN/1.11.x/docker.html | 30 +++---- docs/zh-CN/1.11.x/docker/index.html | 30 +++---- docs/zh-CN/1.11.x/publishing.html | 60 ++++++------- docs/zh-CN/1.11.x/publishing/index.html | 60 ++++++------- docs/zh-CN/1.11.x/site-config.html | 16 ++-- docs/zh-CN/1.11.x/site-config/index.html | 16 ++-- docs/zh-CN/1.11.x/translation.html | 64 ++++++------- docs/zh-CN/1.11.x/translation/index.html | 64 ++++++------- docs/zh-CN/1.12.0/adding-blog.html | 2 +- docs/zh-CN/1.12.0/adding-blog/index.html | 2 +- docs/zh-CN/1.12.0/doc-markdown.html | 4 +- docs/zh-CN/1.12.0/doc-markdown/index.html | 4 +- docs/zh-CN/1.12.0/docker.html | 30 +++---- docs/zh-CN/1.12.0/docker/index.html | 30 +++---- docs/zh-CN/1.12.0/publishing.html | 60 ++++++------- docs/zh-CN/1.12.0/publishing/index.html | 60 ++++++------- docs/zh-CN/1.12.0/site-config.html | 16 ++-- docs/zh-CN/1.12.0/site-config/index.html | 16 ++-- docs/zh-CN/1.12.0/translation.html | 64 ++++++------- docs/zh-CN/1.12.0/translation/index.html | 64 ++++++------- docs/zh-CN/1.13.0/adding-blog.html | 2 +- docs/zh-CN/1.13.0/adding-blog/index.html | 2 +- docs/zh-CN/1.13.0/doc-markdown.html | 4 +- docs/zh-CN/1.13.0/doc-markdown/index.html | 4 +- docs/zh-CN/1.13.0/docker.html | 30 +++---- docs/zh-CN/1.13.0/docker/index.html | 30 +++---- docs/zh-CN/1.13.0/publishing.html | 60 ++++++------- docs/zh-CN/1.13.0/publishing/index.html | 60 ++++++------- docs/zh-CN/1.13.0/site-config.html | 16 ++-- docs/zh-CN/1.13.0/site-config/index.html | 16 ++-- docs/zh-CN/1.13.0/translation.html | 64 ++++++------- docs/zh-CN/1.13.0/translation/index.html | 64 ++++++------- docs/zh-CN/1.9.x/adding-blog.html | 2 +- docs/zh-CN/1.9.x/adding-blog/index.html | 2 +- docs/zh-CN/1.9.x/doc-markdown.html | 4 +- docs/zh-CN/1.9.x/doc-markdown/index.html | 4 +- docs/zh-CN/1.9.x/docker.html | 30 +++---- docs/zh-CN/1.9.x/docker/index.html | 30 +++---- docs/zh-CN/1.9.x/publishing.html | 60 ++++++------- docs/zh-CN/1.9.x/publishing/index.html | 60 ++++++------- docs/zh-CN/1.9.x/site-config.html | 16 ++-- docs/zh-CN/1.9.x/site-config/index.html | 16 ++-- docs/zh-CN/1.9.x/translation.html | 64 ++++++------- docs/zh-CN/1.9.x/translation/index.html | 64 ++++++------- docs/zh-CN/adding-blog.html | 2 +- docs/zh-CN/adding-blog/index.html | 2 +- docs/zh-CN/doc-markdown.html | 4 +- docs/zh-CN/doc-markdown/index.html | 4 +- docs/zh-CN/docker.html | 30 +++---- docs/zh-CN/docker/index.html | 30 +++---- docs/zh-CN/next/adding-blog.html | 2 +- docs/zh-CN/next/adding-blog/index.html | 2 +- docs/zh-CN/next/doc-markdown.html | 4 +- docs/zh-CN/next/doc-markdown/index.html | 4 +- docs/zh-CN/next/docker.html | 30 +++---- docs/zh-CN/next/docker/index.html | 30 +++---- docs/zh-CN/next/publishing.html | 60 ++++++------- docs/zh-CN/next/publishing/index.html | 60 ++++++------- docs/zh-CN/next/site-config.html | 16 ++-- docs/zh-CN/next/site-config/index.html | 16 ++-- docs/zh-CN/next/translation.html | 64 ++++++------- docs/zh-CN/next/translation/index.html | 64 ++++++------- docs/zh-CN/publishing.html | 60 ++++++------- docs/zh-CN/publishing/index.html | 60 ++++++------- docs/zh-CN/site-config.html | 16 ++-- docs/zh-CN/site-config/index.html | 16 ++-- docs/zh-CN/translation.html | 64 ++++++------- docs/zh-CN/translation/index.html | 64 ++++++------- 603 files changed, 8877 insertions(+), 8877 deletions(-) diff --git a/css/main.css b/css/main.css index d07a29a174..49c890a9e7 100644 --- a/css/main.css +++ b/css/main.css @@ -1 +1 @@ -a,abbr,acronym,address,applet,article,aside,audio,b,big,blockquote,body,canvas,caption,center,cite,code,dd,del,details,dfn,div,dl,dt,em,embed,fieldset,figcaption,figure,footer,form,h1,h2,h3,h4,h5,h6,header,hgroup,html,i,iframe,img,ins,kbd,label,legend,li,mark,menu,nav,object,ol,output,p,pre,q,ruby,s,samp,section,small,span,strike,strong,sub,summary,sup,table,tbody,td,tfoot,th,thead,time,tr,tt,u,ul,var,video{border:0;font:inherit;font-size:100%;margin:0;padding:0;vertical-align:baseline}body{color:#24292e;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol;font-size:16px;line-height:1.5;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;word-wrap:break-word}*{box-sizing:border-box}b,strong{font-weight:600}em,i{font-style:italic}[type=checkbox]{box-sizing:border-box;padding:0}a,a:hover{color:#2e8555;text-decoration:none}a:active,a:hover{outline-width:0}a:not([href]){color:inherit;text-decoration:none}p{margin-bottom:1em;margin-top:0}h1,h2,h3,h4,h5,h6{color:inherit;font-weight:600;line-height:1.25;margin-bottom:16px;margin-top:1.5em}h1{font-size:32px}h2{font-size:24px}h3{font-size:20px}h4{font-size:16px}h5{font-size:14px}h6{font-size:13.6px}ol,ul{margin-bottom:1em;margin-top:0;padding-left:2em}ol ol,ul ol{list-style-type:lower-roman}ol ol,ol ul,ul ol,ul ul{margin-bottom:0;margin-top:0}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}li{word-wrap:break-all}li>p{margin-top:1em}li+li{margin-top:.25em}img{border-style:none;box-sizing:content-box;max-width:100%}img[align=right]{padding-left:1.25em}img[align=left]{padding-right:1.25em}table{border-collapse:collapse;border-spacing:0;display:block;margin-bottom:16px;margin-top:0;overflow:auto;width:100%}table tr{background-color:transparent;border-top:1px solid #dfe2e5}table tr:nth-child(2n){background-color:#f6f8fa}table td,table th{border:1px solid #dfe2e5;padding:6px 13px}table th{background-color:inherit;font-weight:600}table td,table th{color:inherit}blockquote{color:#6a737d;font-size:16px;margin:0 0 16px;padding:0 1em}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}code{background-color:rgba(27,31,35,.05);border-radius:3px;color:inherit;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:85%;margin:0;padding:3.2px 6.4px}pre{margin-bottom:16px}pre code{background-color:transparent;border:0;display:inline;font-size:85%;line-height:inherit;margin:0;max-width:auto;overflow:visible;padding:0;white-space:pre;word-break:normal;word-wrap:normal}kbd{background-color:#fafbfc;border:1px solid #d1d5da;border-bottom-color:#c6cbd1;border-radius:3px;box-shadow:inset 0 -1px 0 #c6cbd1;color:#444d56;display:inline-block;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:68.75%;line-height:10px;padding:3px 5px;vertical-align:middle}hr{border:1px solid #dfe2e5;box-sizing:content-box;margin:1.5em 0;overflow:hidden;padding:0}hr:after,hr:before{content:"";display:table}hr:after{clear:both}body{background-color:#fff;min-height:100vh;text-rendering:optimizeLegibility}@media only screen and (min-width:736px){body{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column}}article:after,article:before{content:"";display:table}article:after{clear:both}article>:first-child{margin-top:0}article>:last-child{margin-bottom:0}article iframe,article p img{display:block;margin-left:auto;margin-right:auto;max-width:100%}.anchor{display:block;position:relative;top:-80px}.hash-link{line-height:1;margin-left:-20px;opacity:0;padding-right:4px;-webkit-transition:opacity .3s;transition:opacity .3s}.hash-link:hover{opacity:1!important;-webkit-transition:none;transition:none}.hash-link .hash-link-icon{vertical-align:middle}.button{border:1px solid #2e8555;border-radius:3px;color:#2e8555;display:inline-block;font-size:14px;font-weight:400;line-height:1.2em;padding:10px;text-decoration:none!important;text-transform:uppercase;-webkit-transition:background .3s,color .3s;transition:background .3s,color .3s}.button:hover{background:#2e8555;color:#fff}h1:hover .hash-link,h2:hover .hash-link,h3:hover .hash-link,h4:hover .hash-link{opacity:.5;-webkit-transition:none;transition:none}blockquote{background-color:rgba(255,229,100,.3);border-left:8px solid #ffe564;padding:15px 30px 15px 15px}.wrapper{margin:0 auto;max-width:1100px;padding:0 20px}.wrapper blockquote>p:first-child{padding-top:0}.center{display:block}.center,.homeContainer{text-align:center}.homeContainer .homeWrapper{padding:2em 10px}.homeContainer .homeWrapper .wrapper{margin:0 auto;max-width:900px;padding:0 20px}.homeContainer .homeWrapper .projectLogo img{height:100px;margin-bottom:0}.homeContainer .homeWrapper #project_title{font-size:300%;letter-spacing:-.08em;line-height:1em;margin-bottom:80px}.homeContainer .homeWrapper #project_tagline{font-size:200%;letter-spacing:-.04em;line-height:1em}.projectLogo{display:none;pointer-events:none}.projectLogo img{height:100px;margin-bottom:0}.projectIntro{margin:40px 0}.projectTitle{color:#2e8555;font-size:250%;line-height:1em}.projectTitle>small{display:block;font-weight:400;font-size:50%;line-height:1em;margin:.7em 0 1.3em}@media only screen and (min-width:480px){.projectTitle{font-size:300%;margin:.3em 0}.projectLogo img{height:200px;margin-bottom:10px}.homeContainer .homeWrapper{padding-left:10px;padding-right:10px}}@media only screen and (min-width:736px){.homeContainer .homeWrapper{position:relative}.homeContainer .homeWrapper #inner{max-width:600px;padding-right:40px}}@media only screen and (min-width:1200px){.homeContainer .homeWrapper #inner{max-width:750px}.homeContainer .homeWrapper .projectLogo{-webkit-box-align:center;align-items:center;bottom:0;display:-webkit-box;display:flex;-webkit-box-pack:end;justify-content:flex-end;left:0;padding:2em 100px 4em;position:absolute;right:0;top:0}.homeContainer .homeWrapper .projectLogo img{height:100%;max-height:250px}}@media only screen and (min-width:1500px){.homeContainer .homeWrapper #inner{max-width:1100px;padding-bottom:40px;padding-top:40px}.wrapper{max-width:1400px}}.mainContainer{-webkit-box-flex:1;flex:1 1 0%;max-width:100%;padding:40px 0}.mainContainer .wrapper{text-align:left}.mainContainer .wrapper .allShareBlock{padding:10px 0}.mainContainer .wrapper .allShareBlock .pluginBlock{margin:12px 0;padding:0}.mainContainer .wrapper .post{position:relative}.mainContainer .wrapper .post.basicPost{margin-top:30px}.mainContainer .wrapper .post .postHeader{margin-bottom:16px}.mainContainer .wrapper .post .postHeaderTitle{margin-top:0;padding:0}.mainContainer .wrapper .post .postSocialPlugins{padding-top:1em}.mainContainer .wrapper .post .docPagination{background:#2e8555;bottom:0;left:0;position:absolute;right:0}.mainContainer .wrapper .post .docPagination .pager{display:inline-block;width:50%}.mainContainer .wrapper .post .docPagination .pagingNext{float:right;text-align:right}.mainContainer .wrapper .post .docPagination a{border:none;color:#fff;display:block;padding:4px 12px}.mainContainer .wrapper .post .docPagination a:hover{background-color:#f9f9f9;color:#393939}.mainContainer .wrapper .post .docPagination a .pagerLabel{display:inline}.mainContainer .wrapper .post .docPagination a .pagerTitle{display:none}@media only screen and (min-width:480px){.mainContainer .wrapper .post .docPagination a .pagerLabel{display:none}.mainContainer .wrapper .post .docPagination a .pagerTitle{display:inline}}@media only screen and (min-width:1024px){.mainContainer .wrapper .post{display:block}.mainContainer .wrapper .posts .post{width:100%}}.fixedHeaderContainer{background:#2e8555;color:#fff;min-height:50px;padding:8px 0;position:fixed;width:100%;z-index:9999;-webkit-transform:translateZ(0);transform:translateZ(0)}@media only screen and (min-width:1024px){.fixedHeaderContainer{flex-shrink:0}}.fixedHeaderContainer a{-webkit-box-align:center;align-items:center;border:0;color:#fff;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;height:34px;z-index:10000}.fixedHeaderContainer header{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;position:relative;text-align:left}.fixedHeaderContainer header img{height:100%;margin-right:10px}.fixedHeaderContainer header .headerTitle{font-size:1.25em;margin:0}.fixedHeaderContainer header .headerTitleWithLogo{display:block;font-size:1.25em;line-height:18px;margin:0;position:relative;z-index:9999}.fixedHeaderContainer header h3{color:#fff;font-size:16px;margin:0 0 0 10px;text-decoration:underline}@media (max-width:480px){.headerTitle{font-size:17px}.headerTitleWithLogo{display:none!important}}.promoSection{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-flow:column wrap;font-size:125%;line-height:1.6em;position:relative;z-index:99}.promoSection .promoRow{padding:10px 0}.promoSection .promoRow .pluginWrapper{display:block}.promoSection .promoRow .pluginWrapper.ghStarWrapper,.promoSection .promoRow .pluginWrapper.ghWatchWrapper{height:28px}.promoSection .promoRow .pluginRowBlock{display:-webkit-box;display:flex;flex-wrap:wrap;-webkit-box-pack:center;justify-content:center;margin:0 -2px}.promoSection .promoRow .pluginRowBlock .pluginWrapper{padding:0 2px}.promoSection .promoRow .pluginRowBlock iframe{margin-left:2px;margin-top:5px}input[type=search]{-moz-appearance:none;-webkit-appearance:none}.navSearchWrapper{-webkit-box-align:center;align-items:center;align-self:center;display:-webkit-box;display:flex;-webkit-box-pack:center;justify-content:center;padding-left:10px;position:absolute;right:10px;top:10px}.navSearchWrapper:before{border:3px solid #e5e5e5;border-radius:50%;content:" ";display:block;height:6px;left:15px;position:absolute;top:50%;-webkit-transform:translateY(-58%);transform:translateY(-58%);width:6px;z-index:1}.navSearchWrapper:after{background:#e5e5e5;content:" ";height:7px;left:24px;position:absolute;top:55%;-webkit-transform:rotate(-45deg);transform:rotate(-45deg);width:3px;z-index:1}.navSearchWrapper .aa-dropdown-menu{background:#f9f9f9;border:3px solid rgba(57,57,57,.25);color:#393939;font-size:14px;left:auto!important;line-height:1.2em;right:0!important}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--category-header{background:#2e8555;color:#fff;font-size:14px;font-weight:400}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight{background-color:#2e8555;color:#fff}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--subcategory-column .algolia-docsearch-suggestion--highlight,.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--title .algolia-docsearch-suggestion--highlight{color:#2e8555}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--subcategory-column,.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion__secondary{border-color:rgba(57,57,57,.3)}input#search_input_react{background-color:rgba(0,0,0,.2);border:none;border-radius:20px;color:#fff;font-size:14px;font-weight:300;line-height:20px;outline:none;padding-left:25px;position:relative;-webkit-transition:width .5s ease;transition:width .5s ease;width:170px}.navSearchWrapper:before{left:24px}.navSearchWrapper:after{left:35px}input#search_input_react:active,input#search_input_react:focus{color:#fff;width:220px}.navigationSlider .slidingNav .navSearchWrapper .algolia-docsearch-footer a{height:auto}@media only screen and (max-width:735px){.navSearchWrapper{width:40%}}input::-webkit-input-placeholder{color:#e5e5e5}input::-moz-placeholder{color:#e5e5e5}input:-ms-input-placeholder{color:#e5e5e5}input::-ms-input-placeholder{color:#e5e5e5}input::placeholder{color:#e5e5e5}.hljs{padding:1.25rem 1.5rem}.gridBlock{padding:0}.gridBlock>*{box-sizing:border-box}.gridBlock .fourByGridBlock img,.gridBlock .threeByGridBlock img,.gridBlock .twoByGridBlock img{max-width:100%}.gridBlock .gridClear{clear:both}@media only screen and (max-width:735px){.gridBlock .fourByGridBlock{-webkit-box-flex:1;flex:1 0 26%}}@media only screen and (min-width:736px){.gridBlock{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-direction:row;flex-wrap:wrap}.gridBlock>*{margin:0 12px}.gridBlock>:first-child{margin-left:0}.gridBlock>:last-child{margin-right:0}.gridBlock .twoByGridBlock{-webkit-box-flex:1;flex:1 0 40%}.gridBlock .threeByGridBlock{-webkit-box-flex:1;flex:1 0 26%}.gridBlock .fourByGridBlock{-webkit-box-flex:1;flex:1 0 20%}h2+.gridBlock{padding-top:20px}}@media only screen and (min-width:1400px){.gridBlock{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-direction:row;flex-wrap:wrap}}.alignCenter{text-align:center}.alignRight{text-align:right}.imageAlignSide{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap}.blockImage{max-width:730px}.imageAlignSide .blockImage{-webkit-box-flex:0;flex:0 1 500px;max-width:500px}@media only screen and (max-width:735px){.imageAlignSide .blockImage{display:none}}.imageAlignSide .blockContent{-webkit-box-flex:1;flex:1 1}.imageAlignBottom .blockImage{margin:0 auto 20px;max-width:730px}.imageAlignBottom.alignCenter .blockImage{margin-left:auto;margin-right:auto}.imageAlignTop .blockImage{margin-bottom:20px;max-width:80px}.imageAlignTop.alignCenter .blockImage{margin-left:auto;margin-right:auto}.imageAlignRight .blockImage{margin-left:40px}.imageAlignLeft .blockImage{margin-right:40px}.container .gridBlock .blockContent p{padding:0}.container .wrapper .alignCenter h2{text-align:center}.container .wrapper .imageAlignSide h2{text-align:left}.container .wrapper .imageAlignSide p{margin:0 0 40px;max-width:560px}.highlightBackground{background:rgba(153,66,79,.7);color:#fff}.highlightBackground a{font-weight:800}.container.highlightBackground .wrapper h1,.container.highlightBackground .wrapper h2,.container.highlightBackground .wrapper h3,.container.highlightBackground .wrapper h4,.container.highlightBackground .wrapper h5,.highlightBackground a{border-color:#fff;color:#fff}.lightBackground{background:#f7f7f7}.darkBackground{background:grey;color:#fff}.darkBackground a,.darkBackground code{color:#d6b3b8}.container.darkBackground .wrapper h1,.container.darkBackground .wrapper h2,.container.darkBackground .wrapper h3,.container.darkBackground .wrapper h4,.container.darkBackground .wrapper h5{border-color:#fff;color:#fff}.container.paddingAll{padding:40px}.container.paddingBottom{padding-bottom:80px}.container.paddingLeft{padding-left:40px}.container.paddingRight{padding-right:40px}.container.paddingTop{padding-top:80px}@media only screen and (max-width:735px){.container.paddingBottom{padding-bottom:40px}.container.paddingTop{padding-top:20px}}@media only screen and (max-width:1023px){.responsiveList .blockContent{position:relative}.responsiveList .blockContent>div{padding-left:20px}.responsiveList .blockContent:before{content:"\2022";position:absolute}}.navigationSlider .navSlideout{cursor:pointer;padding-top:4px;position:absolute;right:10px;top:0;-webkit-transition:top .3s;transition:top .3s;z-index:101}.navigationSlider .slidingNav{bottom:auto;box-sizing:border-box;left:0;position:fixed;right:0;top:0}.navigationSlider .slidingNav.slidingNavActive{height:auto;padding-top:42px;width:300px}.navigationSlider .slidingNav ul{background:#205c3b;box-sizing:border-box;color:#fff;display:-webkit-box;display:flex;flex-wrap:nowrap;list-style:none;margin-top:50px;padding:0;width:100%}.navigationSlider .slidingNav.slidingNavActive ul{display:block}.navigationSlider .slidingNav ul li{-webkit-box-flex:1;flex:1 1 auto;margin:0;text-align:center;white-space:nowrap}.navigationSlider .slidingNav ul li a{-webkit-box-align:center;align-items:center;box-sizing:border-box;color:#2e8555;color:inherit;display:-webkit-box;display:flex;font-size:.9em;height:auto;height:50px;-webkit-box-pack:center;justify-content:center;margin:0;padding:10px;-webkit-transition:background-color .3s;transition:background-color .3s}.navigationSlider .slidingNav ul li.siteNavGroupActive>a,.navigationSlider .slidingNav ul li.siteNavItemActive>a,.navigationSlider .slidingNav ul li>a:focus,.navigationSlider .slidingNav ul li>a:hover{background-color:#2e8555}.languages-icon{width:20px}#languages-dropdown{pointer-events:none;position:absolute;width:100%}#languages-dropdown.visible{display:-webkit-box;display:flex}#languages-dropdown.hide{display:none}#languages-dropdown-items{background-color:#2e8555;display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;min-width:120px;pointer-events:all}#languages li{display:block}.navPusher{left:0;min-height:100%;padding-top:100px;position:relative;z-index:99}.singleRowMobileNav.navPusher{padding-top:50px}.navPusher:after{background:rgba(0,0,0,.4);content:"";height:0;opacity:0;position:absolute;right:0;top:0;-webkit-transition:opacity .5s,width .1s .5s,height .1s .5s;transition:opacity .5s,width .1s .5s,height .1s .5s;width:0}@media screen and (min-width:1024px){.navPusher{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;min-height:calc(100vh - 50px);padding-top:50px}.navPusher,.navPusher>:first-child{-webkit-box-flex:1;flex-grow:1}}.sliderActive .navPusher:after{height:100%;opacity:1;-webkit-transition:opacity .5s;transition:opacity .5s;width:100%;z-index:100}@media only screen and (max-width:1024px){.reactNavSearchWrapper input#search_input_react{background-color:rgba(242,196,178,.25);border:none;border-radius:20px;box-sizing:border-box;color:#393939;font-size:14px;line-height:20px;outline:none;padding-left:38px;position:relative;-webkit-transition:background-color .2s cubic-bezier(.68,-.55,.265,1.55),width .2s cubic-bezier(.68,-.55,.265,1.55),color .2s ease;transition:background-color .2s cubic-bezier(.68,-.55,.265,1.55),width .2s cubic-bezier(.68,-.55,.265,1.55),color .2s ease;width:100%;height:30px}.reactNavSearchWrapper input#search_input_react:active,.reactNavSearchWrapper input#search_input_react:focus{background-color:#2e8555;color:#fff}.reactNavSearchWrapper .algolia-docsearch-suggestion--subcategory-inline{display:none}.reactNavSearchWrapper>span{width:100%}.reactNavSearchWrapper .aa-dropdown-menu{font-size:12px;line-height:2em;padding:0;border-width:1px;min-width:500px}.reactNavSearchWrapper .algolia-docsearch-suggestion__secondary{border-top:none}.aa-suggestions{min-height:140px;max-height:60vh;-webkit-overflow-scrolling:touch;overflow-y:scroll}#languages-dropdown{left:0;top:50px}#languages-dropdown-items{background-color:#2e8555;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-direction:row}}@media only screen and (min-width:1024px){.navSearchWrapper{padding-left:10px;position:relative;right:auto;top:auto}.reactNavSearchWrapper input#search_input_react{height:100%;padding-top:8px;padding-bottom:8px;padding-left:38px}.navSearchWrapper .algolia-autocomplete{display:block}.navigationSlider{height:34px;margin-left:auto;position:relative}.navigationSlider .navSlideout{display:none}.navigationSlider nav.slidingNav{background:none;height:auto;position:relative;right:auto;top:auto;width:auto}.navigationSlider .slidingNav ul{background:none;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;margin:0;padding:0;width:auto}.navigationSlider .slidingNav ul li a{border:0;color:hsla(0,0%,100%,.8);display:-webkit-box;display:flex;font-size:16px;font-size:1em;font-weight:300;height:32px;line-height:1.2em;margin:0;padding:6px 10px}.navigationSlider .slidingNav ul li.siteNavGroupActive a,.navigationSlider .slidingNav ul li.siteNavItemActive a,.navigationSlider .slidingNav ul li a:hover{color:#fff}}@media only screen and (max-width:735px){.navigationSlider .slidingNav ul{overflow-x:auto}.navigationSlider .slidingNav ul::-webkit-scrollbar{display:none}.reactNavSearchWrapper .aa-dropdown-menu{min-width:400px}}@media only screen and (max-width:475px){.reactNavSearchWrapper .aa-dropdown-menu{min-width:300px}}.docMainWrapper .wrapper{padding-left:0;padding-right:0;padding-top:10px}@media only screen and (min-width:1024px){.docMainWrapper{width:100%}.docMainWrapper>*{margin:0 24px}.docMainWrapper>:first-child{margin-left:0}.docMainWrapper>:last-child{margin-right:0}.docMainWrapper .mainContainer{min-width:0}}.edit-page-link{float:right;font-size:10px;font-weight:400;margin-top:3px;text-decoration:none}@media only screen and (max-width:1023px){.edit-page-link{display:none}}.docLastUpdate{font-size:13px;font-style:italic;margin:20px 0;text-align:right}.docs-prevnext{margin:20px 0}.docs-prevnext:after{clear:both;content:" ";display:table}.docs-next{float:right}.docs-prev{float:left}@media only screen and (max-width:735px){.docs-next{clear:both;float:left}.docs-next,.docs-prev{margin:10px 0}.arrow-next{float:right;margin-left:10px}.arrow-prev{float:left;margin-right:10px}.function-name-prevnext{width:200px;display:inline-block;white-space:nowrap;overflow:hidden;text-overflow:ellipsis}}.hide{display:none}.collapsible{cursor:pointer}.collapsible .arrow{float:right;margin-right:8px;margin-top:-4px;-webkit-transform:rotate(90deg);transform:rotate(90deg);-webkit-transition:-webkit-transform .2s linear;transition:-webkit-transform .2s linear;transition:transform .2s linear;transition:transform .2s linear, -webkit-transform .2s linear}.collapsible .arrow.rotate{-webkit-transform:rotate(180deg);transform:rotate(180deg)}@media only screen and (max-width:1023px){.docsNavContainer{background:#fff;left:0;position:fixed;width:100%;z-index:100}}@media only screen and (min-width:1024px){.docsNavContainer{-webkit-box-flex:0;flex:0 0 240px;height:calc(100vh - 50px);position:-webkit-sticky;position:sticky;overflow-y:auto;top:50px}}.docsSliderActive.docsNavContainer{box-sizing:border-box;height:100%;-webkit-overflow-scrolling:touch;overflow-y:auto;-ms-scroll-chaining:none;overscroll-behavior:contain;padding-bottom:50px}.docsNavContainer .toc .navBreadcrumb{background-color:#f1f1f1;box-sizing:border-box;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;font-size:12px;height:48px;overflow:hidden;padding:8px 20px}.docsNavContainer .toc .navWrapper{padding:0}@media only screen and (min-width:1024px){.docsNavContainer .toc .navBreadcrumb{display:none}.navBreadcrumb h2{padding:0 10px}.separateOnPageNav .docsNavContainer{-webkit-box-flex:0;flex:0 0 240px}}.navBreadcrumb a,.navBreadcrumb span{border:0;color:#393939}@media only screen and (max-width:735px){.anchor{top:-144px}}@media only screen and (min-width:1024px){.toc{padding:40px 0}}.toc section{padding:0;position:relative}.toc section .navGroups{display:none;padding:48px 20px 60px}.toc .toggleNav{color:#393939;position:relative}.toc .toggleNav .navToggle{cursor:pointer;height:32px;margin-right:10px;position:relative;text-align:left;width:18px}.hamburger-menu{position:absolute;top:6px;width:100%}.line1,.line2,.line3{width:100%;height:3px;background-color:#393939;margin:3px 0;-webkit-transition:.4s;transition:.4s;border-radius:10px}.docsSliderActive .hamburger-menu{top:12px}.docsSliderActive .line1{position:absolute;top:50%;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}.docsSliderActive .line2{display:none}.docsSliderActive .line3{position:absolute;top:50%;-webkit-transform:rotate(45deg);transform:rotate(45deg)}.toggleNav h2 i{padding:0 4px}.toc .toggleNav .navGroup{margin-bottom:16px}.toc .toggleNav .subNavGroup{margin-bottom:0}.toc .toggleNav .navGroup .navGroupCategoryTitle{color:#393939;font-size:18px;font-weight:500;line-height:1.2em;margin-bottom:8px;margin-top:0}.toc .toggleNav .navGroup .navGroupSubcategoryTitle{color:#393939;font-size:14px;font-weight:500;line-height:1.5;margin-bottom:0;margin-top:0;padding:4px 0}.toc .toggleNav .navGroup .navListItem{margin:0}.toc .toggleNav .navGroup h3 i:not(:empty){box-sizing:border-box;color:rgba(57,57,57,.5);display:inline-block;height:16px;margin-right:10px;text-align:center;-webkit-transition:color .2s;transition:color .2s;width:16px}.toc .toggleNav ul{padding:0 8px}.docsSliderActive .toc .toggleNav ul{padding-left:0}.toc .toggleNav ul li{list-style-type:none;padding:0}.toc .toggleNav ul li a{border:none;color:#717171;display:block;font-size:14px;padding:4px 0;-webkit-transition:color .3s;transition:color .3s}.toc .toggleNav ul li.navListItemActive a,.toc .toggleNav ul li a:focus,.toc .toggleNav ul li a:hover{color:#2e8555}.docsSliderActive .toc .navBreadcrumb,.tocActive .navBreadcrumb{border-bottom:1px solid #ccc;margin-bottom:20px;position:fixed;width:100%}.toc .toggleNav .navBreadcrumb h2{border:0;-webkit-box-flex:1;flex-grow:1;font-size:16px;font-weight:600;line-height:32px;margin:0;padding:0}.docsSliderActive .toc section .navGroups{display:block;padding-top:60px}.tocToggler{cursor:pointer;height:32px;line-height:32px;margin-right:-10px;padding:0 10px}.icon-toc{box-sizing:border-box;display:inline-block;line-height:normal;position:relative;top:-1px;vertical-align:middle}.icon-toc,.icon-toc:after,.icon-toc:before{background-color:currentColor;border:1px solid;border-radius:50%;box-sizing:border-box;height:4px;width:4px}.icon-toc:after,.icon-toc:before{content:"";position:absolute}.icon-toc:before{left:-1px;top:-7px}.icon-toc:after{left:-1px;top:5px}.tocActive .icon-toc{border-radius:0;height:16px;-webkit-transform:rotate(45deg);transform:rotate(45deg);width:3px}.tocActive .icon-toc:before{border-radius:0;height:3px;left:50%;top:50%;-webkit-transform:translate(-50%,-50%);transform:translate(-50%,-50%);width:16px}.tocActive .icon-toc:after{content:""}@media only screen and (min-width:1024px){.docMainWrapper{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap}.docMainWrapper .wrapper{padding-top:0;padding-left:0;padding-right:0}}.onPageNav{display:none;margin-bottom:40px}.onPageNav::-webkit-scrollbar{width:7px}.onPageNav::-webkit-scrollbar-track{background:#f1f1f1;border-radius:10px}.onPageNav::-webkit-scrollbar-thumb{background:#888;border-radius:10px}.onPageNav::-webkit-scrollbar-thumb:hover{background:#555}.onPageNav a{color:#717171}.onPageNav .toc-headings>li>a.active,.onPageNav .toc-headings>li>a.hover{font-weight:600;color:#2e8555}.onPageNav ul{list-style:none}.onPageNav ul li{font-size:12px;line-height:16px;padding-bottom:8px}.onPageNav ul ul{padding:8px 0 0 20px}.onPageNav ul ul li{padding-bottom:5px}@media only screen and (min-width:1024px){.toc section .navGroups{display:block;padding:8px 0 0}.navBreadcrumb h2{padding:0 10px}}@supports ((position: -webkit-sticky) or (position: sticky)){@media only screen and (max-width:1023px){.tocActive .onPageNav{background:#fff;bottom:0;display:block;left:0;overflow-y:auto;-ms-scroll-chaining:none;overscroll-behavior:contain;padding:0 20px;position:fixed;right:0;top:148px;z-index:10;margin-bottom:0}.tocActive .singleRowMobileNav .onPageNav{top:98px}.tocActive .navBreadcrumb h2,.tocActive .navToggle{visibility:hidden}.tocActive .onPageNav>.toc-headings{padding:12px 0}}@media only screen and (min-width:1024px){.separateOnPageNav .headerWrapper.wrapper,.separateOnPageNav .wrapper{max-width:1400px}.separateOnPageNav .toc{width:auto}.separateOnPageNav.sideNavVisible .navPusher .mainContainer{-webkit-box-flex:1;flex:1 auto;max-width:100%;min-width:0}.onPageNav{align-self:flex-start;display:block;-webkit-box-flex:0;flex:0 0 240px;max-height:calc(100vh - 90px);overflow-y:auto;position:-webkit-sticky;position:sticky;top:90px}.onPageNav>.toc-headings{border-left:1px solid #e0e0e0;padding:10px 0 2px 15px}.tocToggler{display:none}}}.blog .wrapper{max-width:1100px}.blogContainer .posts .post{border-bottom:1px solid #e0e0e0;border-radius:3px;margin-bottom:20px;padding-bottom:20px}.blogContainer .postHeader{margin-bottom:10px}.blogContainer .postHeaderTitle{margin-top:0}.blogContainer .postHeader p.post-meta{margin-bottom:10px;padding:0}.blogContainer .postHeader .authorBlock{display:-webkit-box;display:flex}.blogContainer .postHeader .post-authorName{color:rgba(57,57,57,.7);display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;font-size:14px;font-weight:400;-webkit-box-pack:center;justify-content:center;margin-right:10px;margin-top:0;margin-bottom:0;padding:0}.blogContainer .postHeader .authorPhoto{border-radius:50%;height:30px;overflow:hidden;width:30px}.blogContainer .postHeader .authorPhoto.authorPhotoBig{height:50px;width:50px}.blog-recent{margin:20px 0}.blog-recent>a{float:left}@media only screen and (max-width:735px){.blog-recent{height:40px}}.blogSocialSection{display:block;padding:36px 0}.blogSocialSection .blogSocialSectionItem{padding-bottom:5px}.fb-like{display:block;margin-bottom:20px;width:100%}.more-users{margin:0 auto;max-width:560px;text-align:center}.productShowcaseSection{padding:0 20px;text-align:center}.productShowcaseSection.paddingTop{padding-top:20px}.productShowcaseSection.paddingBottom{padding-bottom:80px}.productShowcaseSection h2{color:#2e8555;font-size:30px;line-height:1em;margin-top:20px;padding:10px 0;text-align:center}.productShowcaseSection p{margin:0 auto;max-width:560px;padding:.8em 0}.productShowcaseSection .logos{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap;-webkit-box-pack:center;justify-content:center;padding:20px}.productShowcaseSection .logos img{max-height:110px;padding:20px;width:110px}@media only screen and (max-width:735px){.productShowcaseSection .logos img{max-height:64px;padding:20px;width:64px}}.showcaseSection{margin:0 auto;max-width:900px}.showcaseSection,.showcaseSection .prose h1{text-align:center}.showcaseSection .prose{margin:0 auto;max-width:560px;text-align:center}.showcaseSection .logos{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap;-webkit-box-pack:center;justify-content:center}.showcaseSection .logos img{max-height:128px;padding:20px;width:128px}@media only screen and (max-width:735px){.showcaseSection .logos img{max-height:64px;padding:20px;width:64px}}.nav-footer{background:#20232a;border:none;color:#202020;font-size:15px;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-weight:400;line-height:24px;padding-bottom:2em;padding-top:2em;position:relative}@media only screen and (min-width:1024px){.nav-footer{flex-shrink:0}}.nav-footer .sitemap{display:-webkit-box;display:flex;-webkit-box-pack:justify;justify-content:space-between;margin:0 auto 3em;max-width:1080px}.nav-footer .sitemap div{-webkit-box-flex:1;flex:1}.nav-footer .sitemap .nav-home{display:table;height:72px;margin:-12px 20px 0 0;opacity:.4;padding:10px;-webkit-transition:opacity .15s ease-in-out;transition:opacity .15s ease-in-out;width:72px}.nav-footer .sitemap .nav-home:focus,.nav-footer .sitemap .nav-home:hover{opacity:1}@media only screen and (max-width:735px){.nav-footer .sitemap{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;margin:0 2em 3em;width:calc(100% - 4em)}.nav-footer .sitemap>div{margin-bottom:18px}}.nav-footer .sitemap a{color:hsla(0,0%,100%,.6);display:block;margin:2px 0;padding:3px 0}.nav-footer .sitemap a:focus,.nav-footer .sitemap a:hover,.nav-footer .sitemap h5>a:focus,.nav-footer .sitemap h5>a:hover{color:#fff;text-decoration:none}.nav-footer .sitemap h5,.nav-footer .sitemap h6{margin:0 0 10px}.nav-footer .sitemap h5,.nav-footer .sitemap h5>a,.nav-footer .sitemap h6,.nav-footer .sitemap h6>a{color:#fff}.nav-footer .sitemap h5>a,.nav-footer .sitemap h6>a{margin:0 -10px}.nav-footer .fbOpenSource{display:block;margin:1em auto;opacity:.4;-webkit-transition:opacity .15s ease-in-out;transition:opacity .15s ease-in-out;width:170px}.nav-footer .fbOpenSource:hover{opacity:1}.nav-footer .copyright{color:hsla(0,0%,100%,.4);text-align:center}.nav-footer .social{padding:5px 0}.tabs{border-top:1px solid #cfcfcf}.nav-tabs{display:-webkit-box;display:flex;border-bottom:4px solid #e0e0e0;width:100%;padding:0;overflow-x:auto;white-space:nowrap;max-height:100%}.nav-tabs::-webkit-scrollbar{display:none}.tabs .tab-pane:focus{outline:none}.tabs .nav-tabs>div{font-size:14px;line-height:1.14286;padding:12px 16px;text-decoration:none;display:block;cursor:pointer}.tabs .nav-tabs>div.active{border-bottom:4px solid #2e8555}.tab-pane{display:none}.tab-pane.active{display:block}.tab-pane>pre{white-space:pre-wrap}.tab-pane>pre>code{margin-top:0;border-radius:0;box-shadow:none}pre{position:relative}pre .btnIcon{position:absolute;top:4px;z-index:2;cursor:pointer;border:1px solid transparent;padding:0;color:#fff;background-color:transparent;height:30px;-webkit-transition:all .25s ease-out;transition:all .25s ease-out}pre .btnIcon:hover{text-decoration:none}.btnIcon__body{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex}.btnIcon svg{fill:currentColor;margin-right:.4em}.btnIcon__label{font-size:11px}.btnClipboard{right:10px}.testimonials img{border-radius:50%}table td:first-child>code{white-space:nowrap}.showcase{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap;-webkit-box-pack:center;justify-content:center;margin-bottom:20px}.showcase .link{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;-webkit-box-pack:justify;justify-content:space-between;height:180px;margin:5px;padding:5px}.showcase .link:hover{text-decoration:underline}.showcase .link .caption{line-height:20px;height:20px}.showcase .link img{max-height:110px;padding:20px;width:110px;align-self:center}@media only screen and (max-width:735px){.showcase .link{height:134px}.showcase .link img{max-height:64px;padding:20px;width:64px}}.announcement{background-color:#20232a;color:#fff;font-weight:700;font-size:24px;padding:48px;margin:0 auto -40px;text-align:center}.announcement-inner{margin:0 auto;max-width:768px}.index-hero{background-color:#2b3137;padding:48px}.index-hero-inner{margin:0 auto;max-width:1100px;padding:0 20px}.index-hero-project-tagline{color:#fff;font-size:64px;margin:0}.index-hero-project-keywords{color:#2e8555}@-webkit-keyframes jackInTheBox{0%{opacity:0;-webkit-transform:scale(.1) rotate(30deg);transform:scale(.1) rotate(30deg);-webkit-transform-origin:center bottom;transform-origin:center bottom}50%{-webkit-transform:rotate(-10deg);transform:rotate(-10deg)}70%{-webkit-transform:rotate(3deg);transform:rotate(3deg)}to{opacity:1;-webkit-transform:scale(1);transform:scale(1)}}@keyframes jackInTheBox{0%{opacity:0;-webkit-transform:scale(.1) rotate(30deg);transform:scale(.1) rotate(30deg);-webkit-transform-origin:center bottom;transform-origin:center bottom}50%{-webkit-transform:rotate(-10deg);transform:rotate(-10deg)}70%{-webkit-transform:rotate(3deg);transform:rotate(3deg)}to{opacity:1;-webkit-transform:scale(1);transform:scale(1)}}.index-hero-logo{-webkit-animation-duration:2s;animation-duration:2s;-webkit-animation-name:jackInTheBox;animation-name:jackInTheBox;float:right;margin-top:20px;padding:20px 0 20px 20px}.index-ctas{margin-top:24px}.index-ctas-get-started-button{border-radius:8px;border-width:2px;color:#fff;font-size:24px;font-weight:700;margin-right:24px;padding:18px 36px}.index-ctas-github-button{vertical-align:sub}@media only screen and (max-width:768px){.announcement{font-size:18px;padding:20px}.index-hero{padding:20px}.index-hero-inner{padding:0}.index-hero-project-tagline{font-size:36px;text-align:center}.index-hero-logo{display:block;float:none;margin:0 auto}.index-ctas{text-align:center}.index-ctas-github-button{display:none}}.imageAlignTop .blockImage{max-width:60%}@media only screen and (max-width:768px){.gridBlock .blockElement.imageAlignTop{margin-bottom:80px}}.docImage{margin:3rem auto;max-width:400px} \ No newline at end of file +a,abbr,acronym,address,applet,article,aside,audio,b,big,blockquote,body,canvas,caption,center,cite,code,dd,del,details,dfn,div,dl,dt,em,embed,fieldset,figcaption,figure,footer,form,h1,h2,h3,h4,h5,h6,header,hgroup,html,i,iframe,img,ins,kbd,label,legend,li,mark,menu,nav,object,ol,output,p,pre,q,ruby,s,samp,section,small,span,strike,strong,sub,summary,sup,table,tbody,td,tfoot,th,thead,time,tr,tt,u,ul,var,video{border:0;font:inherit;font-size:100%;margin:0;padding:0;vertical-align:baseline}body{color:#24292e;font-family:-apple-system,BlinkMacSystemFont,Segoe UI,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol;font-size:16px;line-height:1.5;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;word-wrap:break-word}*{box-sizing:border-box}b,strong{font-weight:600}em,i{font-style:italic}[type=checkbox]{box-sizing:border-box;padding:0}a{color:#2e8555;text-decoration:none}a:hover{color:#2e8555;text-decoration:none}a:active,a:hover{outline-width:0}a:not([href]){color:inherit;text-decoration:none}p{margin-bottom:1em;margin-top:0}h1,h2,h3,h4,h5,h6{color:inherit;font-weight:600;line-height:1.25;margin-bottom:16px;margin-top:1.5em}h1{font-size:32px}h2{font-size:24px}h3{font-size:20px}h4{font-size:16px}h5{font-size:14px}h6{font-size:13.6px}ol,ul{margin-bottom:1em;margin-top:0;padding-left:2em}ol ol,ul ol{list-style-type:lower-roman}ol ol,ol ul,ul ol,ul ul{margin-bottom:0;margin-top:0}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}li{word-wrap:break-all}li>p{margin-top:1em}li+li{margin-top:.25em}img{border-style:none;box-sizing:content-box;max-width:100%}img[align=right]{padding-left:1.25em}img[align=left]{padding-right:1.25em}table{border-collapse:collapse;border-spacing:0;display:block;margin-bottom:16px;margin-top:0;overflow:auto;width:100%}table tr{background-color:transparent;border-top:1px solid #dfe2e5}table tr:nth-child(2n){background-color:#f6f8fa}table td,table th{border:1px solid #dfe2e5;padding:6px 13px}table th{background-color:inherit;font-weight:600}table td,table th{color:inherit}blockquote{color:#6a737d;font-size:16px;margin:0 0 16px;padding:0 1em}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}code{background-color:rgba(27,31,35,.05);border-radius:3px;color:inherit;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:85%;margin:0;padding:3.2px 6.4px}pre{margin-bottom:16px}pre code{background-color:transparent;border:0;display:inline;font-size:85%;line-height:inherit;margin:0;max-width:auto;overflow:visible;padding:0;white-space:pre;word-break:normal;word-wrap:normal}kbd{background-color:#fafbfc;border:1px solid #d1d5da;border-bottom-color:#c6cbd1;border-radius:3px;box-shadow:inset 0 -1px 0 #c6cbd1;color:#444d56;display:inline-block;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:68.75%;line-height:10px;padding:3px 5px;vertical-align:middle}hr{border:1px solid #dfe2e5;box-sizing:content-box;margin:1.5em 0;overflow:hidden;padding:0}hr:before{content:"";display:table}hr:after{clear:both;content:"";display:table}body{background-color:#fff;min-height:100vh;text-rendering:optimizeLegibility}@media only screen and (min-width:736px){body{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column}}article:before{content:"";display:table}article:after{clear:both;content:"";display:table}article>:first-child{margin-top:0}article>:last-child{margin-bottom:0}article iframe,article p img{display:block;margin-left:auto;margin-right:auto;max-width:100%}.anchor{display:block;position:relative;top:-80px}.hash-link{line-height:1;margin-left:-20px;opacity:0;padding-right:4px;-webkit-transition:opacity .3s;transition:opacity .3s}.hash-link:hover{opacity:1!important;-webkit-transition:none;transition:none}.hash-link .hash-link-icon{vertical-align:middle}.button{border:1px solid #2e8555;border-radius:3px;color:#2e8555;display:inline-block;font-size:14px;font-weight:400;line-height:1.2em;padding:10px;text-decoration:none!important;text-transform:uppercase;-webkit-transition:background .3s,color .3s;transition:background .3s,color .3s}.button:hover{background:#2e8555;color:#fff}h1:hover .hash-link,h2:hover .hash-link,h3:hover .hash-link,h4:hover .hash-link{opacity:.5;-webkit-transition:none;transition:none}blockquote{background-color:rgba(255,229,100,.3);border-left:8px solid #ffe564;padding:15px 30px 15px 15px}.wrapper{margin:0 auto;max-width:1100px;padding:0 20px}.wrapper blockquote>p:first-child{padding-top:0}.center{display:block}.center,.homeContainer{text-align:center}.homeContainer .homeWrapper{padding:2em 10px}.homeContainer .homeWrapper .wrapper{margin:0 auto;max-width:900px;padding:0 20px}.homeContainer .homeWrapper .projectLogo img{height:100px;margin-bottom:0}.homeContainer .homeWrapper #project_title{font-size:300%;letter-spacing:-.08em;line-height:1em;margin-bottom:80px}.homeContainer .homeWrapper #project_tagline{font-size:200%;letter-spacing:-.04em;line-height:1em}.projectLogo{display:none;pointer-events:none}.projectLogo img{height:100px;margin-bottom:0}.projectIntro{margin:40px 0}.projectTitle{color:#2e8555;font-size:250%;line-height:1em}.projectTitle>small{display:block;font-weight:400;font-size:50%;line-height:1em;margin:.7em 0 1.3em}@media only screen and (min-width:480px){.projectTitle{font-size:300%;margin:.3em 0}.projectLogo img{height:200px;margin-bottom:10px}.homeContainer .homeWrapper{padding-left:10px;padding-right:10px}}@media only screen and (min-width:736px){.homeContainer .homeWrapper{position:relative}.homeContainer .homeWrapper #inner{max-width:600px;padding-right:40px}}@media only screen and (min-width:1200px){.homeContainer .homeWrapper #inner{max-width:750px}.homeContainer .homeWrapper .projectLogo{-webkit-box-align:center;align-items:center;bottom:0;display:-webkit-box;display:flex;-webkit-box-pack:end;justify-content:flex-end;left:0;padding:2em 100px 4em;position:absolute;right:0;top:0}.homeContainer .homeWrapper .projectLogo img{height:100%;max-height:250px}}@media only screen and (min-width:1500px){.homeContainer .homeWrapper #inner{max-width:1100px;padding-bottom:40px;padding-top:40px}.wrapper{max-width:1400px}}.mainContainer{-webkit-box-flex:1;flex:1 1 0%;max-width:100%;padding:40px 0}.mainContainer .wrapper{text-align:left}.mainContainer .wrapper .allShareBlock{padding:10px 0}.mainContainer .wrapper .allShareBlock .pluginBlock{margin:12px 0;padding:0}.mainContainer .wrapper .post{position:relative}.mainContainer .wrapper .post.basicPost{margin-top:30px}.mainContainer .wrapper .post .postHeader{margin-bottom:16px}.mainContainer .wrapper .post .postHeaderTitle{margin-top:0;padding:0}.mainContainer .wrapper .post .postSocialPlugins{padding-top:1em}.mainContainer .wrapper .post .docPagination{background:#2e8555;bottom:0;left:0;position:absolute;right:0}.mainContainer .wrapper .post .docPagination .pager{display:inline-block;width:50%}.mainContainer .wrapper .post .docPagination .pagingNext{float:right;text-align:right}.mainContainer .wrapper .post .docPagination a{border:none;color:#fff;display:block;padding:4px 12px}.mainContainer .wrapper .post .docPagination a:hover{background-color:#f9f9f9;color:#393939}.mainContainer .wrapper .post .docPagination a .pagerLabel{display:inline}.mainContainer .wrapper .post .docPagination a .pagerTitle{display:none}@media only screen and (min-width:480px){.mainContainer .wrapper .post .docPagination a .pagerLabel{display:none}.mainContainer .wrapper .post .docPagination a .pagerTitle{display:inline}}@media only screen and (min-width:1024px){.mainContainer .wrapper .post{display:block}.mainContainer .wrapper .posts .post{width:100%}}.fixedHeaderContainer{background:#2e8555;color:#fff;min-height:50px;padding:8px 0;position:fixed;width:100%;z-index:9999;-webkit-transform:translateZ(0);transform:translateZ(0)}@media only screen and (min-width:1024px){.fixedHeaderContainer{flex-shrink:0}}.fixedHeaderContainer a{-webkit-box-align:center;align-items:center;border:0;color:#fff;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;height:34px;z-index:10000}.fixedHeaderContainer header{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;position:relative;text-align:left}.fixedHeaderContainer header img{height:100%;margin-right:10px}.fixedHeaderContainer header .headerTitle{font-size:1.25em;margin:0}.fixedHeaderContainer header .headerTitleWithLogo{display:block;font-size:1.25em;line-height:18px;margin:0;position:relative;z-index:9999}.fixedHeaderContainer header h3{color:#fff;font-size:16px;margin:0 0 0 10px;text-decoration:underline}@media (max-width:480px){.headerTitle{font-size:17px}.headerTitleWithLogo{display:none!important}}.promoSection{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-flow:column wrap;font-size:125%;line-height:1.6em;position:relative;z-index:99}.promoSection .promoRow{padding:10px 0}.promoSection .promoRow .pluginWrapper{display:block}.promoSection .promoRow .pluginWrapper.ghStarWrapper,.promoSection .promoRow .pluginWrapper.ghWatchWrapper{height:28px}.promoSection .promoRow .pluginRowBlock{display:-webkit-box;display:flex;flex-wrap:wrap;-webkit-box-pack:center;justify-content:center;margin:0 -2px}.promoSection .promoRow .pluginRowBlock .pluginWrapper{padding:0 2px}.promoSection .promoRow .pluginRowBlock iframe{margin-left:2px;margin-top:5px}input[type=search]{-moz-appearance:none;-webkit-appearance:none}.navSearchWrapper{-webkit-box-align:center;align-items:center;align-self:center;display:-webkit-box;display:flex;-webkit-box-pack:center;justify-content:center;padding-left:10px;position:absolute;right:10px;top:10px}.navSearchWrapper:before{border:3px solid #e5e5e5;border-radius:50%;content:" ";display:block;height:6px;left:15px;position:absolute;top:50%;-webkit-transform:translateY(-58%);transform:translateY(-58%);width:6px;z-index:1}.navSearchWrapper:after{background:#e5e5e5;content:" ";height:7px;left:24px;position:absolute;top:55%;-webkit-transform:rotate(-45deg);transform:rotate(-45deg);width:3px;z-index:1}.navSearchWrapper .aa-dropdown-menu{background:#f9f9f9;border:3px solid rgba(57,57,57,.25);color:#393939;font-size:14px;left:auto!important;line-height:1.2em;right:0!important}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--category-header{background:#2e8555;color:#fff;font-size:14px;font-weight:400}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight{background-color:#2e8555;color:#fff}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--subcategory-column .algolia-docsearch-suggestion--highlight,.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--title .algolia-docsearch-suggestion--highlight{color:#2e8555}.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion--subcategory-column,.navSearchWrapper .aa-dropdown-menu .algolia-docsearch-suggestion__secondary{border-color:rgba(57,57,57,.3)}input#search_input_react{background-color:rgba(0,0,0,.2);border:none;border-radius:20px;color:#fff;font-size:14px;font-weight:300;line-height:20px;outline:none;padding-left:25px;position:relative;-webkit-transition:width .5s ease;transition:width .5s ease;width:170px}.navSearchWrapper:before{left:24px}.navSearchWrapper:after{left:35px}input#search_input_react:active,input#search_input_react:focus{color:#fff;width:220px}.navigationSlider .slidingNav .navSearchWrapper .algolia-docsearch-footer a{height:auto}@media only screen and (max-width:735px){.navSearchWrapper{width:40%}}input::-webkit-input-placeholder{color:#e5e5e5}input::-moz-placeholder{color:#e5e5e5}input:-ms-input-placeholder{color:#e5e5e5}input::-ms-input-placeholder{color:#e5e5e5}input::placeholder{color:#e5e5e5}.hljs{padding:1.25rem 1.5rem}.gridBlock{padding:0}.gridBlock>*{box-sizing:border-box}.gridBlock .fourByGridBlock img,.gridBlock .threeByGridBlock img,.gridBlock .twoByGridBlock img{max-width:100%}.gridBlock .gridClear{clear:both}@media only screen and (max-width:735px){.gridBlock .fourByGridBlock{-webkit-box-flex:1;flex:1 0 26%}}@media only screen and (min-width:736px){.gridBlock{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-direction:row;flex-wrap:wrap}.gridBlock>*{margin:0 12px}.gridBlock>:first-child{margin-left:0}.gridBlock>:last-child{margin-right:0}.gridBlock .twoByGridBlock{-webkit-box-flex:1;flex:1 0 40%}.gridBlock .threeByGridBlock{-webkit-box-flex:1;flex:1 0 26%}.gridBlock .fourByGridBlock{-webkit-box-flex:1;flex:1 0 20%}h2+.gridBlock{padding-top:20px}}@media only screen and (min-width:1400px){.gridBlock{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-direction:row;flex-wrap:wrap}}.alignCenter{text-align:center}.alignRight{text-align:right}.imageAlignSide{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap}.blockImage{max-width:730px}.imageAlignSide .blockImage{-webkit-box-flex:0;flex:0 1 500px;max-width:500px}@media only screen and (max-width:735px){.imageAlignSide .blockImage{display:none}}.imageAlignSide .blockContent{-webkit-box-flex:1;flex:1 1}.imageAlignBottom .blockImage{margin:0 auto 20px;max-width:730px}.imageAlignBottom.alignCenter .blockImage{margin-left:auto;margin-right:auto}.imageAlignTop .blockImage{margin-bottom:20px;max-width:80px}.imageAlignTop.alignCenter .blockImage{margin-left:auto;margin-right:auto}.imageAlignRight .blockImage{margin-left:40px}.imageAlignLeft .blockImage{margin-right:40px}.container .gridBlock .blockContent p{padding:0}.container .wrapper .alignCenter h2{text-align:center}.container .wrapper .imageAlignSide h2{text-align:left}.container .wrapper .imageAlignSide p{margin:0 0 40px;max-width:560px}.highlightBackground{background:rgba(153,66,79,.7);color:#fff}.highlightBackground a{font-weight:800}.container.highlightBackground .wrapper h1,.container.highlightBackground .wrapper h2,.container.highlightBackground .wrapper h3,.container.highlightBackground .wrapper h4,.container.highlightBackground .wrapper h5,.highlightBackground a{border-color:#fff;color:#fff}.lightBackground{background:#f7f7f7}.darkBackground{background:grey;color:#fff}.darkBackground a,.darkBackground code{color:#d6b3b8}.container.darkBackground .wrapper h1,.container.darkBackground .wrapper h2,.container.darkBackground .wrapper h3,.container.darkBackground .wrapper h4,.container.darkBackground .wrapper h5{border-color:#fff;color:#fff}.container.paddingAll{padding:40px}.container.paddingBottom{padding-bottom:80px}.container.paddingLeft{padding-left:40px}.container.paddingRight{padding-right:40px}.container.paddingTop{padding-top:80px}@media only screen and (max-width:735px){.container.paddingBottom{padding-bottom:40px}.container.paddingTop{padding-top:20px}}@media only screen and (max-width:1023px){.responsiveList .blockContent{position:relative}.responsiveList .blockContent>div{padding-left:20px}.responsiveList .blockContent:before{content:"\2022";position:absolute}}.navigationSlider .navSlideout{cursor:pointer;padding-top:4px;position:absolute;right:10px;top:0;-webkit-transition:top .3s;transition:top .3s;z-index:101}.navigationSlider .slidingNav{bottom:auto;box-sizing:border-box;left:0;position:fixed;right:0;top:0}.navigationSlider .slidingNav.slidingNavActive{height:auto;padding-top:42px;width:300px}.navigationSlider .slidingNav ul{background:#205c3b;box-sizing:border-box;color:#fff;display:-webkit-box;display:flex;flex-wrap:nowrap;list-style:none;margin-top:50px;padding:0;width:100%}.navigationSlider .slidingNav.slidingNavActive ul{display:block}.navigationSlider .slidingNav ul li{-webkit-box-flex:1;flex:1 1 auto;margin:0;text-align:center;white-space:nowrap}.navigationSlider .slidingNav ul li a{-webkit-box-align:center;align-items:center;box-sizing:border-box;color:#2e8555;color:inherit;display:-webkit-box;display:flex;font-size:.9em;height:auto;height:50px;-webkit-box-pack:center;justify-content:center;margin:0;padding:10px;-webkit-transition:background-color .3s;transition:background-color .3s}.navigationSlider .slidingNav ul li.siteNavGroupActive>a,.navigationSlider .slidingNav ul li.siteNavItemActive>a,.navigationSlider .slidingNav ul li>a:focus,.navigationSlider .slidingNav ul li>a:hover{background-color:#2e8555}.languages-icon{width:20px}#languages-dropdown{pointer-events:none;position:absolute;width:100%}#languages-dropdown.visible{display:-webkit-box;display:flex}#languages-dropdown.hide{display:none}#languages-dropdown-items{background-color:#2e8555;display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;min-width:120px;pointer-events:all}#languages li{display:block}.navPusher{left:0;min-height:100%;padding-top:100px;position:relative;z-index:99}.singleRowMobileNav.navPusher{padding-top:50px}.navPusher:after{background:rgba(0,0,0,.4);content:"";height:0;opacity:0;position:absolute;right:0;top:0;-webkit-transition:opacity .5s,width .1s .5s,height .1s .5s;transition:opacity .5s,width .1s .5s,height .1s .5s;width:0}@media screen and (min-width:1024px){.navPusher{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;-webkit-box-flex:1;flex-grow:1;min-height:calc(100vh - 50px);padding-top:50px}.navPusher>:first-child{-webkit-box-flex:1;flex-grow:1}}.sliderActive .navPusher:after{height:100%;opacity:1;-webkit-transition:opacity .5s;transition:opacity .5s;width:100%;z-index:100}@media only screen and (max-width:1024px){.reactNavSearchWrapper input#search_input_react{background-color:rgba(242,196,178,.25);border:none;border-radius:20px;box-sizing:border-box;color:#393939;font-size:14px;line-height:20px;outline:none;padding-left:38px;position:relative;-webkit-transition:background-color .2s cubic-bezier(.68,-.55,.265,1.55),width .2s cubic-bezier(.68,-.55,.265,1.55),color .2s ease;transition:background-color .2s cubic-bezier(.68,-.55,.265,1.55),width .2s cubic-bezier(.68,-.55,.265,1.55),color .2s ease;width:100%;height:30px}.reactNavSearchWrapper input#search_input_react:active,.reactNavSearchWrapper input#search_input_react:focus{background-color:#2e8555;color:#fff}.reactNavSearchWrapper .algolia-docsearch-suggestion--subcategory-inline{display:none}.reactNavSearchWrapper>span{width:100%}.reactNavSearchWrapper .aa-dropdown-menu{font-size:12px;line-height:2em;padding:0;border-width:1px;min-width:500px}.reactNavSearchWrapper .algolia-docsearch-suggestion__secondary{border-top:none}.aa-suggestions{min-height:140px;max-height:60vh;-webkit-overflow-scrolling:touch;overflow-y:scroll}#languages-dropdown{left:0;top:50px}#languages-dropdown-items{background-color:#2e8555;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-direction:row}}@media only screen and (min-width:1024px){.navSearchWrapper{padding-left:10px;position:relative;right:auto;top:auto}.reactNavSearchWrapper input#search_input_react{height:100%;padding-top:8px;padding-bottom:8px;padding-left:38px}.navSearchWrapper .algolia-autocomplete{display:block}.navigationSlider{height:34px;margin-left:auto;position:relative}.navigationSlider .navSlideout{display:none}.navigationSlider nav.slidingNav{background:none;height:auto;position:relative;right:auto;top:auto;width:auto}.navigationSlider .slidingNav ul{background:none;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;margin:0;padding:0;width:auto}.navigationSlider .slidingNav ul li a{border:0;color:hsla(0,0%,100%,.8);display:-webkit-box;display:flex;font-size:16px;font-size:1em;font-weight:300;height:32px;line-height:1.2em;margin:0;padding:6px 10px}.navigationSlider .slidingNav ul li.siteNavGroupActive a,.navigationSlider .slidingNav ul li.siteNavItemActive a,.navigationSlider .slidingNav ul li a:hover{color:#fff}}@media only screen and (max-width:735px){.navigationSlider .slidingNav ul{overflow-x:auto}.navigationSlider .slidingNav ul::-webkit-scrollbar{display:none}.reactNavSearchWrapper .aa-dropdown-menu{min-width:400px}}@media only screen and (max-width:475px){.reactNavSearchWrapper .aa-dropdown-menu{min-width:300px}}.docMainWrapper .wrapper{padding-left:0;padding-right:0;padding-top:10px}@media only screen and (min-width:1024px){.docMainWrapper{width:100%}.docMainWrapper>*{margin:0 24px}.docMainWrapper>:first-child{margin-left:0}.docMainWrapper>:last-child{margin-right:0}.docMainWrapper .mainContainer{min-width:0}}.edit-page-link{float:right;font-size:10px;font-weight:400;margin-top:3px;text-decoration:none}@media only screen and (max-width:1023px){.edit-page-link{display:none}}.docLastUpdate{font-size:13px;font-style:italic;margin:20px 0;text-align:right}.docs-prevnext{margin:20px 0}.docs-prevnext:after{clear:both;content:" ";display:table}.docs-next{float:right}.docs-prev{float:left}@media only screen and (max-width:735px){.docs-next{clear:both;float:left}.docs-next,.docs-prev{margin:10px 0}.arrow-next{float:right;margin-left:10px}.arrow-prev{float:left;margin-right:10px}.function-name-prevnext{width:200px;display:inline-block;white-space:nowrap;overflow:hidden;text-overflow:ellipsis}}.hide{display:none}.collapsible{cursor:pointer}.collapsible .arrow{float:right;margin-right:8px;margin-top:-4px;-webkit-transform:rotate(90deg);transform:rotate(90deg);-webkit-transition:-webkit-transform .2s linear;transition:-webkit-transform .2s linear;transition:transform .2s linear;transition:transform .2s linear, -webkit-transform .2s linear}.collapsible .arrow.rotate{-webkit-transform:rotate(180deg);transform:rotate(180deg)}@media only screen and (max-width:1023px){.docsNavContainer{background:#fff;left:0;position:fixed;width:100%;z-index:100}}@media only screen and (min-width:1024px){.docsNavContainer{-webkit-box-flex:0;flex:0 0 240px;height:calc(100vh - 50px);position:-webkit-sticky;position:sticky;overflow-y:auto;top:50px}}.docsSliderActive.docsNavContainer{box-sizing:border-box;height:100%;-webkit-overflow-scrolling:touch;overflow-y:auto;-ms-scroll-chaining:none;overscroll-behavior:contain;padding-bottom:50px}.docsNavContainer .toc .navBreadcrumb{background-color:#f1f1f1;box-sizing:border-box;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap;font-size:12px;height:48px;overflow:hidden;padding:8px 20px}.docsNavContainer .toc .navWrapper{padding:0}@media only screen and (min-width:1024px){.docsNavContainer .toc .navBreadcrumb{display:none}.navBreadcrumb h2{padding:0 10px}.separateOnPageNav .docsNavContainer{-webkit-box-flex:0;flex:0 0 240px}}.navBreadcrumb a,.navBreadcrumb span{border:0;color:#393939}@media only screen and (max-width:735px){.anchor{top:-144px}}@media only screen and (min-width:1024px){.toc{padding:40px 0}}.toc section{padding:0;position:relative}.toc section .navGroups{display:none;padding:48px 20px 60px}.toc .toggleNav{color:#393939;position:relative}.toc .toggleNav .navToggle{cursor:pointer;height:32px;margin-right:10px;position:relative;text-align:left;width:18px}.hamburger-menu{position:absolute;top:6px;width:100%}.line1,.line2,.line3{width:100%;height:3px;background-color:#393939;margin:3px 0;-webkit-transition:.4s;transition:.4s;border-radius:10px}.docsSliderActive .hamburger-menu{top:12px}.docsSliderActive .line1{position:absolute;top:50%;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}.docsSliderActive .line2{display:none}.docsSliderActive .line3{position:absolute;top:50%;-webkit-transform:rotate(45deg);transform:rotate(45deg)}.toggleNav h2 i{padding:0 4px}.toc .toggleNav .navGroup{margin-bottom:16px}.toc .toggleNav .subNavGroup{margin-bottom:0}.toc .toggleNav .navGroup .navGroupCategoryTitle{color:#393939;font-size:18px;font-weight:500;line-height:1.2em;margin-bottom:8px;margin-top:0}.toc .toggleNav .navGroup .navGroupSubcategoryTitle{color:#393939;font-size:14px;font-weight:500;line-height:1.5;margin-bottom:0;margin-top:0;padding:4px 0}.toc .toggleNav .navGroup .navListItem{margin:0}.toc .toggleNav .navGroup h3 i:not(:empty){box-sizing:border-box;color:rgba(57,57,57,.5);display:inline-block;height:16px;margin-right:10px;text-align:center;-webkit-transition:color .2s;transition:color .2s;width:16px}.toc .toggleNav ul{padding:0 8px}.docsSliderActive .toc .toggleNav ul{padding-left:0}.toc .toggleNav ul li{list-style-type:none;padding:0}.toc .toggleNav ul li a{border:none;color:#717171;display:block;font-size:14px;padding:4px 0;-webkit-transition:color .3s;transition:color .3s}.toc .toggleNav ul li a:focus,.toc .toggleNav ul li a:hover{color:#2e8555}.toc .toggleNav ul li.navListItemActive a{color:#2e8555}.docsSliderActive .toc .navBreadcrumb,.tocActive .navBreadcrumb{border-bottom:1px solid #ccc;margin-bottom:20px;position:fixed;width:100%}.toc .toggleNav .navBreadcrumb h2{border:0;-webkit-box-flex:1;flex-grow:1;font-size:16px;font-weight:600;line-height:32px;margin:0;padding:0}.docsSliderActive .toc section .navGroups{display:block;padding-top:60px}.tocToggler{cursor:pointer;height:32px;line-height:32px;margin-right:-10px;padding:0 10px}.icon-toc{box-sizing:border-box;display:inline-block;line-height:normal;position:relative;top:-1px;vertical-align:middle}.icon-toc,.icon-toc:after,.icon-toc:before{background-color:currentColor;border:1px solid;border-radius:50%;box-sizing:border-box;height:4px;width:4px}.icon-toc:after,.icon-toc:before{content:"";position:absolute}.icon-toc:before{left:-1px;top:-7px}.icon-toc:after{left:-1px;top:5px}.tocActive .icon-toc{border-radius:0;height:16px;-webkit-transform:rotate(45deg);transform:rotate(45deg);width:3px}.tocActive .icon-toc:before{border-radius:0;height:3px;left:50%;top:50%;-webkit-transform:translate(-50%,-50%);transform:translate(-50%,-50%);width:16px}.tocActive .icon-toc:after{content:""}@media only screen and (min-width:1024px){.docMainWrapper{display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row nowrap}.docMainWrapper .wrapper{padding-top:0;padding-left:0;padding-right:0}}.onPageNav{display:none;margin-bottom:40px}.onPageNav::-webkit-scrollbar{width:7px}.onPageNav::-webkit-scrollbar-track{background:#f1f1f1;border-radius:10px}.onPageNav::-webkit-scrollbar-thumb{background:#888;border-radius:10px}.onPageNav::-webkit-scrollbar-thumb:hover{background:#555}.onPageNav a{color:#717171}.onPageNav .toc-headings>li>a.active,.onPageNav .toc-headings>li>a.hover{font-weight:600;color:#2e8555}.onPageNav ul{list-style:none}.onPageNav ul li{font-size:12px;line-height:16px;padding-bottom:8px}.onPageNav ul ul{padding:8px 0 0 20px}.onPageNav ul ul li{padding-bottom:5px}@media only screen and (min-width:1024px){.toc section .navGroups{display:block;padding:8px 0 0}.navBreadcrumb h2{padding:0 10px}}@supports ((position: -webkit-sticky) or (position: sticky)){@media only screen and (max-width:1023px){.tocActive .onPageNav{background:#fff;bottom:0;display:block;left:0;overflow-y:auto;-ms-scroll-chaining:none;overscroll-behavior:contain;padding:0 20px;position:fixed;right:0;top:148px;z-index:10;margin-bottom:0}.tocActive .singleRowMobileNav .onPageNav{top:98px}.tocActive .navBreadcrumb h2,.tocActive .navToggle{visibility:hidden}.tocActive .onPageNav>.toc-headings{padding:12px 0}}@media only screen and (min-width:1024px){.separateOnPageNav .headerWrapper.wrapper,.separateOnPageNav .wrapper{max-width:1400px}.separateOnPageNav .toc{width:auto}.separateOnPageNav.sideNavVisible .navPusher .mainContainer{-webkit-box-flex:1;flex:1 auto;max-width:100%;min-width:0}.onPageNav{align-self:flex-start;display:block;-webkit-box-flex:0;flex:0 0 240px;max-height:calc(100vh - 90px);overflow-y:auto;position:-webkit-sticky;position:sticky;top:90px}.onPageNav>.toc-headings{border-left:1px solid #e0e0e0;padding:10px 0 2px 15px}.tocToggler{display:none}}}.blog .wrapper{max-width:1100px}.blogContainer .posts .post{border-bottom:1px solid #e0e0e0;border-radius:3px;margin-bottom:20px;padding-bottom:20px}.blogContainer .postHeader{margin-bottom:10px}.blogContainer .postHeaderTitle{margin-top:0}.blogContainer .postHeader p.post-meta{margin-bottom:10px;padding:0}.blogContainer .postHeader .authorBlock{display:-webkit-box;display:flex}.blogContainer .postHeader .post-authorName{color:rgba(57,57,57,.7);display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;font-size:14px;font-weight:400;-webkit-box-pack:center;justify-content:center;margin-right:10px;margin-top:0;margin-bottom:0;padding:0}.blogContainer .postHeader .authorPhoto{border-radius:50%;height:30px;overflow:hidden;width:30px}.blogContainer .postHeader .authorPhoto.authorPhotoBig{height:50px;width:50px}.blog-recent{margin:20px 0}.blog-recent>a{float:left}@media only screen and (max-width:735px){.blog-recent{height:40px}}.blogSocialSection{display:block;padding:36px 0}.blogSocialSection .blogSocialSectionItem{padding-bottom:5px}.fb-like{display:block;margin-bottom:20px;width:100%}.more-users{margin:0 auto;max-width:560px;text-align:center}.productShowcaseSection{padding:0 20px;text-align:center}.productShowcaseSection.paddingTop{padding-top:20px}.productShowcaseSection.paddingBottom{padding-bottom:80px}.productShowcaseSection h2{color:#2e8555;font-size:30px;line-height:1em;margin-top:20px;padding:10px 0;text-align:center}.productShowcaseSection p{margin:0 auto;max-width:560px;padding:.8em 0}.productShowcaseSection .logos{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap;-webkit-box-pack:center;justify-content:center;padding:20px}.productShowcaseSection .logos img{max-height:110px;padding:20px;width:110px}@media only screen and (max-width:735px){.productShowcaseSection .logos img{max-height:64px;padding:20px;width:64px}}.showcaseSection{margin:0 auto;max-width:900px}.showcaseSection,.showcaseSection .prose h1{text-align:center}.showcaseSection .prose{margin:0 auto;max-width:560px;text-align:center}.showcaseSection .logos{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap;-webkit-box-pack:center;justify-content:center}.showcaseSection .logos img{max-height:128px;padding:20px;width:128px}@media only screen and (max-width:735px){.showcaseSection .logos img{max-height:64px;padding:20px;width:64px}}.nav-footer{background:#20232a;border:none;color:#202020;font-size:15px;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-weight:400;line-height:24px;padding-bottom:2em;padding-top:2em;position:relative}@media only screen and (min-width:1024px){.nav-footer{flex-shrink:0}}.nav-footer .sitemap{display:-webkit-box;display:flex;-webkit-box-pack:justify;justify-content:space-between;margin:0 auto 3em;max-width:1080px}.nav-footer .sitemap div{-webkit-box-flex:1;flex:1}.nav-footer .sitemap .nav-home{display:table;height:72px;margin:-12px 20px 0 0;opacity:.4;padding:10px;-webkit-transition:opacity .15s ease-in-out;transition:opacity .15s ease-in-out;width:72px}.nav-footer .sitemap .nav-home:focus,.nav-footer .sitemap .nav-home:hover{opacity:1}@media only screen and (max-width:735px){.nav-footer .sitemap{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;margin:0 2em 3em;width:calc(100% - 4em)}.nav-footer .sitemap>div{margin-bottom:18px}}.nav-footer .sitemap a{color:hsla(0,0%,100%,.6);display:block;margin:2px 0;padding:3px 0}.nav-footer .sitemap a:focus,.nav-footer .sitemap a:hover{color:#fff;text-decoration:none}.nav-footer .sitemap h5>a:focus,.nav-footer .sitemap h5>a:hover{color:#fff;text-decoration:none}.nav-footer .sitemap h5,.nav-footer .sitemap h6{margin:0 0 10px}.nav-footer .sitemap h5{color:#fff}.nav-footer .sitemap h5>a,.nav-footer .sitemap h6,.nav-footer .sitemap h6>a{color:#fff}.nav-footer .sitemap h5>a,.nav-footer .sitemap h6>a{margin:0 -10px}.nav-footer .fbOpenSource{display:block;margin:1em auto;opacity:.4;-webkit-transition:opacity .15s ease-in-out;transition:opacity .15s ease-in-out;width:170px}.nav-footer .fbOpenSource:hover{opacity:1}.nav-footer .copyright{color:hsla(0,0%,100%,.4);text-align:center}.nav-footer .social{padding:5px 0}.tabs{border-top:1px solid #cfcfcf}.nav-tabs{display:-webkit-box;display:flex;border-bottom:4px solid #e0e0e0;width:100%;padding:0;overflow-x:auto;white-space:nowrap;max-height:100%}.nav-tabs::-webkit-scrollbar{display:none}.tabs .tab-pane:focus{outline:none}.tabs .nav-tabs>div{font-size:14px;line-height:1.14286;padding:12px 16px;text-decoration:none;display:block;cursor:pointer}.tabs .nav-tabs>div.active{border-bottom:4px solid #2e8555}.tab-pane{display:none}.tab-pane.active{display:block}.tab-pane>pre{white-space:pre-wrap}.tab-pane>pre>code{margin-top:0;border-radius:0;box-shadow:none}pre{position:relative}pre .btnIcon{position:absolute;top:4px;z-index:2;cursor:pointer;border:1px solid transparent;padding:0;color:#fff;background-color:transparent;height:30px;-webkit-transition:all .25s ease-out;transition:all .25s ease-out}pre .btnIcon:hover{text-decoration:none}.btnIcon__body{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex}.btnIcon svg{fill:currentColor;margin-right:.4em}.btnIcon__label{font-size:11px}.btnClipboard{right:10px}.testimonials img{border-radius:50%}table td:first-child>code{white-space:nowrap}.showcase{-webkit-box-align:center;align-items:center;display:-webkit-box;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;flex-flow:row wrap;-webkit-box-pack:center;justify-content:center;margin-bottom:20px}.showcase .link{display:-webkit-box;display:flex;-webkit-box-orient:vertical;-webkit-box-direction:normal;flex-direction:column;-webkit-box-pack:justify;justify-content:space-between;height:180px;margin:5px;padding:5px}.showcase .link:hover{text-decoration:underline}.showcase .link .caption{line-height:20px;height:20px}.showcase .link img{max-height:110px;padding:20px;width:110px;align-self:center}@media only screen and (max-width:735px){.showcase .link{height:134px}.showcase .link img{max-height:64px;padding:20px;width:64px}}.announcement{background-color:#20232a;color:#fff;font-weight:700;font-size:24px;padding:48px;margin:0 auto -40px;text-align:center}.announcement-inner{margin:0 auto;max-width:768px}.index-hero{background-color:#2b3137;padding:48px}.index-hero-inner{margin:0 auto;max-width:1100px;padding:0 20px}.index-hero-project-tagline{color:#fff;font-size:64px;margin:0}.index-hero-project-keywords{color:#2e8555}@-webkit-keyframes jackInTheBox{0%{opacity:0;-webkit-transform:scale(.1) rotate(30deg);transform:scale(.1) rotate(30deg);-webkit-transform-origin:center bottom;transform-origin:center bottom}50%{-webkit-transform:rotate(-10deg);transform:rotate(-10deg)}70%{-webkit-transform:rotate(3deg);transform:rotate(3deg)}to{opacity:1;-webkit-transform:scale(1);transform:scale(1)}}@keyframes jackInTheBox{0%{opacity:0;-webkit-transform:scale(.1) rotate(30deg);transform:scale(.1) rotate(30deg);-webkit-transform-origin:center bottom;transform-origin:center bottom}50%{-webkit-transform:rotate(-10deg);transform:rotate(-10deg)}70%{-webkit-transform:rotate(3deg);transform:rotate(3deg)}to{opacity:1;-webkit-transform:scale(1);transform:scale(1)}}.index-hero-logo{-webkit-animation-duration:2s;animation-duration:2s;-webkit-animation-name:jackInTheBox;animation-name:jackInTheBox;float:right;margin-top:20px;padding:20px 0 20px 20px}.index-ctas{margin-top:24px}.index-ctas-get-started-button{border-radius:8px;border-width:2px;color:#fff;font-size:24px;font-weight:700;margin-right:24px;padding:18px 36px}.index-ctas-github-button{vertical-align:sub}@media only screen and (max-width:768px){.announcement{font-size:18px;padding:20px}.index-hero{padding:20px}.index-hero-inner{padding:0}.index-hero-project-tagline{font-size:36px;text-align:center}.index-hero-logo{display:block;float:none;margin:0 auto}.index-ctas{text-align:center}.index-ctas-github-button{display:none}}.imageAlignTop .blockImage{max-width:60%}@media only screen and (max-width:768px){.gridBlock .blockElement.imageAlignTop{margin-bottom:80px}}.docImage{margin:3rem auto;max-width:400px} \ No newline at end of file diff --git a/docs/en/1.10.x/adding-blog.html b/docs/en/1.10.x/adding-blog.html index 3d3e675d45..02eff8cb09 100644 --- a/docs/en/1.10.x/adding-blog.html +++ b/docs/en/1.10.x/adding-blog.html @@ -94,7 +94,7 @@

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

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/en/1.10.x/adding-blog/index.html b/docs/en/1.10.x/adding-blog/index.html
index 3d3e675d45..02eff8cb09 100644
--- a/docs/en/1.10.x/adding-blog/index.html
+++ b/docs/en/1.10.x/adding-blog/index.html
@@ -94,7 +94,7 @@
 

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

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/en/1.10.x/doc-markdown.html b/docs/en/1.10.x/doc-markdown.html
index 67abf89d9c..ed1d5f99b6 100644
--- a/docs/en/1.10.x/doc-markdown.html
+++ b/docs/en/1.10.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Blog Posts

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/en/1.10.x/doc-markdown/index.html b/docs/en/1.10.x/doc-markdown/index.html index 67abf89d9c..ed1d5f99b6 100644 --- a/docs/en/1.10.x/doc-markdown/index.html +++ b/docs/en/1.10.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Blog Posts

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/en/1.10.x/docker.html b/docs/en/1.10.x/docker.html index 4be6ed1bb5..09d4e05229 100644 --- a/docs/en/1.10.x/docker.html +++ b/docs/en/1.10.x/docker.html @@ -108,21 +108,21 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+  docusaurus:
+    build: .
+    ports:
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/en/1.10.x/docker/index.html b/docs/en/1.10.x/docker/index.html index 4be6ed1bb5..09d4e05229 100644 --- a/docs/en/1.10.x/docker/index.html +++ b/docs/en/1.10.x/docker/index.html @@ -108,21 +108,21 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+  docusaurus:
+    build: .
+    ports:
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/en/1.10.x/publishing.html b/docs/en/1.10.x/publishing.html index 155bf1ded7..42bb94f447 100644 --- a/docs/en/1.10.x/publishing.html +++ b/docs/en/1.10.x/publishing.html @@ -141,7 +141,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -208,26 +208,26 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+    steps:
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-      - deploy-website:
+
+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.

@@ -259,12 +259,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -278,18 +278,18 @@ e.g.
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/en/1.10.x/publishing/index.html b/docs/en/1.10.x/publishing/index.html index 155bf1ded7..42bb94f447 100644 --- a/docs/en/1.10.x/publishing/index.html +++ b/docs/en/1.10.x/publishing/index.html @@ -141,7 +141,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -208,26 +208,26 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+    steps:
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-      - deploy-website:
+
+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.

@@ -259,12 +259,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -278,18 +278,18 @@ e.g.
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/en/1.10.x/site-config.html b/docs/en/1.10.x/site-config.html index 314b039384..943c2e6d34 100644 --- a/docs/en/1.10.x/site-config.html +++ b/docs/en/1.10.x/site-config.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -291,12 +291,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.10.x/site-config/index.html b/docs/en/1.10.x/site-config/index.html index 314b039384..943c2e6d34 100644 --- a/docs/en/1.10.x/site-config/index.html +++ b/docs/en/1.10.x/site-config/index.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -291,12 +291,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.10.x/translation.html b/docs/en/1.10.x/translation.html index 47370736de..6c2e8b11b6 100644 --- a/docs/en/1.10.x/translation.html +++ b/docs/en/1.10.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc
Docusaurus
Docs
Put the Site Online

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

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

-
const siteConfig = {
-  ...
+
const siteConfig = {
+  ...
   url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
   baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
   projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
   organizationName: 'USERNAME' // Your GitHub username.
-  ...
+  ...
 }
 
    diff --git a/docs/en/1.10.x/tutorial-publish-site/index.html b/docs/en/1.10.x/tutorial-publish-site/index.html index 1ae661febf..129456a617 100644 --- a/docs/en/1.10.x/tutorial-publish-site/index.html +++ b/docs/en/1.10.x/tutorial-publish-site/index.html @@ -85,13 +85,13 @@

    Put the Site Online

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

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

    -
    const siteConfig = {
    -  ...
    +
    const siteConfig = {
    +  ...
       url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
       baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
       projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
       organizationName: 'USERNAME' // Your GitHub username.
    -  ...
    +  ...
     }
     
      diff --git a/docs/en/1.11.x/adding-blog.html b/docs/en/1.11.x/adding-blog.html index 0893daf404..196809f5fd 100644 --- a/docs/en/1.11.x/adding-blog.html +++ b/docs/en/1.11.x/adding-blog.html @@ -94,7 +94,7 @@

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

      ---
       author: Frank Li
      -authorURL: https://twitter.com/foobarbaz
      +authorURL: https://twitter.com/foobarbaz
       authorFBID: 503283835
       title: Introducing Docusaurus
       ---
      diff --git a/docs/en/1.11.x/adding-blog/index.html b/docs/en/1.11.x/adding-blog/index.html
      index 0893daf404..196809f5fd 100644
      --- a/docs/en/1.11.x/adding-blog/index.html
      +++ b/docs/en/1.11.x/adding-blog/index.html
      @@ -94,7 +94,7 @@
       

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

      ---
       author: Frank Li
      -authorURL: https://twitter.com/foobarbaz
      +authorURL: https://twitter.com/foobarbaz
       authorFBID: 503283835
       title: Introducing Docusaurus
       ---
      diff --git a/docs/en/1.11.x/doc-markdown.html b/docs/en/1.11.x/doc-markdown.html
      index c91796fd3d..bc185d70af 100644
      --- a/docs/en/1.11.x/doc-markdown.html
      +++ b/docs/en/1.11.x/doc-markdown.html
      @@ -109,7 +109,7 @@
       
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -122,7 +122,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/1.11.x/doc-markdown/index.html b/docs/en/1.11.x/doc-markdown/index.html index c91796fd3d..bc185d70af 100644 --- a/docs/en/1.11.x/doc-markdown/index.html +++ b/docs/en/1.11.x/doc-markdown/index.html @@ -109,7 +109,7 @@
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -122,7 +122,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/1.11.x/docker.html b/docs/en/1.11.x/docker.html index 68b96b89c3..8ce4a2ad64 100644 --- a/docs/en/1.11.x/docker.html +++ b/docs/en/1.11.x/docker.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/1.11.x/docker/index.html b/docs/en/1.11.x/docker/index.html index 68b96b89c3..8ce4a2ad64 100644 --- a/docs/en/1.11.x/docker/index.html +++ b/docs/en/1.11.x/docker/index.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/1.11.x/publishing.html b/docs/en/1.11.x/publishing.html index e398d04e50..0e996072b5 100644 --- a/docs/en/1.11.x/publishing.html +++ b/docs/en/1.11.x/publishing.html @@ -141,7 +141,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -208,26 +208,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -259,12 +259,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

      Using Travis CI

      @@ -278,18 +278,18 @@ e.g.
      # .travis.yml
       language: node_js
       node_js:
      -  - '8'
      +  - '8'
       branches:
      -  only:
      -    - master
      +  only:
      +    - master
       cache:
      -  yarn: true
      +  yarn: true
       script:
      -  - git config --global user.name "${GH_NAME}"
      -  - git config --global user.email "${GH_EMAIL}"
      -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
      -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
      -
      + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

      Hosting on ZEIT Now

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

      diff --git a/docs/en/1.11.x/publishing/index.html b/docs/en/1.11.x/publishing/index.html index e398d04e50..0e996072b5 100644 --- a/docs/en/1.11.x/publishing/index.html +++ b/docs/en/1.11.x/publishing/index.html @@ -141,7 +141,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -208,26 +208,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -259,12 +259,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

    Using Travis CI

    @@ -278,18 +278,18 @@ e.g.
    # .travis.yml
     language: node_js
     node_js:
    -  - '8'
    +  - '8'
     branches:
    -  only:
    -    - master
    +  only:
    +    - master
     cache:
    -  yarn: true
    +  yarn: true
     script:
    -  - git config --global user.name "${GH_NAME}"
    -  - git config --global user.email "${GH_EMAIL}"
    -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
    -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
    -
    + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/en/1.11.x/site-config.html b/docs/en/1.11.x/site-config.html index 9cf78ea2c5..b4346f1b7c 100644 --- a/docs/en/1.11.x/site-config.html +++ b/docs/en/1.11.x/site-config.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -301,12 +301,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.11.x/site-config/index.html b/docs/en/1.11.x/site-config/index.html index 9cf78ea2c5..b4346f1b7c 100644 --- a/docs/en/1.11.x/site-config/index.html +++ b/docs/en/1.11.x/site-config/index.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -301,12 +301,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.11.x/translation.html b/docs/en/1.11.x/translation.html index 25cf00e3b3..7b2a05e59c 100644 --- a/docs/en/1.11.x/translation.html +++ b/docs/en/1.11.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc
Docusaurus
Docs
Put the Site Online

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

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

-
const siteConfig = {
-  ...
+
const siteConfig = {
+  ...
   url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
   baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
   projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
   organizationName: 'USERNAME' // Your GitHub username.
-  ...
+  ...
 }
 
    diff --git a/docs/en/1.11.x/tutorial-publish-site/index.html b/docs/en/1.11.x/tutorial-publish-site/index.html index 43678adeab..5b091c8fc7 100644 --- a/docs/en/1.11.x/tutorial-publish-site/index.html +++ b/docs/en/1.11.x/tutorial-publish-site/index.html @@ -85,13 +85,13 @@

    Put the Site Online

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

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

    -
    const siteConfig = {
    -  ...
    +
    const siteConfig = {
    +  ...
       url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
       baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
       projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
       organizationName: 'USERNAME' // Your GitHub username.
    -  ...
    +  ...
     }
     
      diff --git a/docs/en/1.12.0/adding-blog.html b/docs/en/1.12.0/adding-blog.html index 953223c376..14ff6b1ddb 100644 --- a/docs/en/1.12.0/adding-blog.html +++ b/docs/en/1.12.0/adding-blog.html @@ -95,7 +95,7 @@
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/1.12.0/adding-blog/index.html b/docs/en/1.12.0/adding-blog/index.html
      index 953223c376..14ff6b1ddb 100644
      --- a/docs/en/1.12.0/adding-blog/index.html
      +++ b/docs/en/1.12.0/adding-blog/index.html
      @@ -95,7 +95,7 @@
       
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/1.12.0/doc-markdown.html b/docs/en/1.12.0/doc-markdown.html
      index fbed3cb999..94ca69a7d2 100644
      --- a/docs/en/1.12.0/doc-markdown.html
      +++ b/docs/en/1.12.0/doc-markdown.html
      @@ -109,7 +109,7 @@
       
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -122,7 +122,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/1.12.0/doc-markdown/index.html b/docs/en/1.12.0/doc-markdown/index.html index fbed3cb999..94ca69a7d2 100644 --- a/docs/en/1.12.0/doc-markdown/index.html +++ b/docs/en/1.12.0/doc-markdown/index.html @@ -109,7 +109,7 @@
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -122,7 +122,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/1.12.0/docker.html b/docs/en/1.12.0/docker.html index c82cf9c056..736256ebb9 100644 --- a/docs/en/1.12.0/docker.html +++ b/docs/en/1.12.0/docker.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/1.12.0/docker/index.html b/docs/en/1.12.0/docker/index.html index c82cf9c056..736256ebb9 100644 --- a/docs/en/1.12.0/docker/index.html +++ b/docs/en/1.12.0/docker/index.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/1.12.0/publishing.html b/docs/en/1.12.0/publishing.html index 86f69014f9..6f3faaaf41 100644 --- a/docs/en/1.12.0/publishing.html +++ b/docs/en/1.12.0/publishing.html @@ -142,7 +142,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -209,26 +209,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -260,12 +260,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

      Using Travis CI

      @@ -279,18 +279,18 @@ e.g.
      # .travis.yml
       language: node_js
       node_js:
      -  - '8'
      +  - '8'
       branches:
      -  only:
      -    - master
      +  only:
      +    - master
       cache:
      -  yarn: true
      +  yarn: true
       script:
      -  - git config --global user.name "${GH_NAME}"
      -  - git config --global user.email "${GH_EMAIL}"
      -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
      -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
      -
      + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

      Hosting on ZEIT Now

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

      diff --git a/docs/en/1.12.0/publishing/index.html b/docs/en/1.12.0/publishing/index.html index 86f69014f9..6f3faaaf41 100644 --- a/docs/en/1.12.0/publishing/index.html +++ b/docs/en/1.12.0/publishing/index.html @@ -142,7 +142,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -209,26 +209,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -260,12 +260,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

    Using Travis CI

    @@ -279,18 +279,18 @@ e.g.
    # .travis.yml
     language: node_js
     node_js:
    -  - '8'
    +  - '8'
     branches:
    -  only:
    -    - master
    +  only:
    +    - master
     cache:
    -  yarn: true
    +  yarn: true
     script:
    -  - git config --global user.name "${GH_NAME}"
    -  - git config --global user.email "${GH_EMAIL}"
    -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
    -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
    -
    + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/en/1.12.0/site-config.html b/docs/en/1.12.0/site-config.html index f1e1c118ec..6fe0e37e8c 100644 --- a/docs/en/1.12.0/site-config.html +++ b/docs/en/1.12.0/site-config.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -301,12 +301,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.12.0/site-config/index.html b/docs/en/1.12.0/site-config/index.html index f1e1c118ec..6fe0e37e8c 100644 --- a/docs/en/1.12.0/site-config/index.html +++ b/docs/en/1.12.0/site-config/index.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -301,12 +301,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.12.0/translation.html b/docs/en/1.12.0/translation.html index fca0ac3f49..155b73b523 100644 --- a/docs/en/1.12.0/translation.html +++ b/docs/en/1.12.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc
Docusaurus
Docs
Put the Site Online

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

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

-
const siteConfig = {
-  ...
+
const siteConfig = {
+  ...
   url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
   baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
   projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
   organizationName: 'USERNAME' // Your GitHub username.
-  ...
+  ...
 }
 
    diff --git a/docs/en/1.12.0/tutorial-publish-site/index.html b/docs/en/1.12.0/tutorial-publish-site/index.html index 4b95218a74..caa7bf98be 100644 --- a/docs/en/1.12.0/tutorial-publish-site/index.html +++ b/docs/en/1.12.0/tutorial-publish-site/index.html @@ -85,13 +85,13 @@

    Put the Site Online

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

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

    -
    const siteConfig = {
    -  ...
    +
    const siteConfig = {
    +  ...
       url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
       baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
       projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
       organizationName: 'USERNAME' // Your GitHub username.
    -  ...
    +  ...
     }
     
      diff --git a/docs/en/1.13.0/adding-blog.html b/docs/en/1.13.0/adding-blog.html index c0fea854d2..aa1222b173 100644 --- a/docs/en/1.13.0/adding-blog.html +++ b/docs/en/1.13.0/adding-blog.html @@ -95,7 +95,7 @@
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/1.13.0/adding-blog/index.html b/docs/en/1.13.0/adding-blog/index.html
      index c0fea854d2..aa1222b173 100644
      --- a/docs/en/1.13.0/adding-blog/index.html
      +++ b/docs/en/1.13.0/adding-blog/index.html
      @@ -95,7 +95,7 @@
       
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/1.13.0/doc-markdown.html b/docs/en/1.13.0/doc-markdown.html
      index 4ac1ae35f0..b5132b36cc 100644
      --- a/docs/en/1.13.0/doc-markdown.html
      +++ b/docs/en/1.13.0/doc-markdown.html
      @@ -109,7 +109,7 @@
       
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -122,7 +122,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/1.13.0/doc-markdown/index.html b/docs/en/1.13.0/doc-markdown/index.html index 4ac1ae35f0..b5132b36cc 100644 --- a/docs/en/1.13.0/doc-markdown/index.html +++ b/docs/en/1.13.0/doc-markdown/index.html @@ -109,7 +109,7 @@
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -122,7 +122,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/1.13.0/docker.html b/docs/en/1.13.0/docker.html index a09b94e907..b48f4ac5de 100644 --- a/docs/en/1.13.0/docker.html +++ b/docs/en/1.13.0/docker.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/1.13.0/docker/index.html b/docs/en/1.13.0/docker/index.html index a09b94e907..b48f4ac5de 100644 --- a/docs/en/1.13.0/docker/index.html +++ b/docs/en/1.13.0/docker/index.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/1.13.0/publishing.html b/docs/en/1.13.0/publishing.html index 2720730f22..404de2877d 100644 --- a/docs/en/1.13.0/publishing.html +++ b/docs/en/1.13.0/publishing.html @@ -142,7 +142,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -209,26 +209,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -260,12 +260,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

      Using Travis CI

      @@ -279,18 +279,18 @@ e.g.
      # .travis.yml
       language: node_js
       node_js:
      -  - '8'
      +  - '8'
       branches:
      -  only:
      -    - master
      +  only:
      +    - master
       cache:
      -  yarn: true
      +  yarn: true
       script:
      -  - git config --global user.name "${GH_NAME}"
      -  - git config --global user.email "${GH_EMAIL}"
      -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
      -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
      -
      + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

      Hosting on ZEIT Now

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

      diff --git a/docs/en/1.13.0/publishing/index.html b/docs/en/1.13.0/publishing/index.html index 2720730f22..404de2877d 100644 --- a/docs/en/1.13.0/publishing/index.html +++ b/docs/en/1.13.0/publishing/index.html @@ -142,7 +142,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -209,26 +209,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -260,12 +260,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

    Using Travis CI

    @@ -279,18 +279,18 @@ e.g.
    # .travis.yml
     language: node_js
     node_js:
    -  - '8'
    +  - '8'
     branches:
    -  only:
    -    - master
    +  only:
    +    - master
     cache:
    -  yarn: true
    +  yarn: true
     script:
    -  - git config --global user.name "${GH_NAME}"
    -  - git config --global user.email "${GH_EMAIL}"
    -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
    -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
    -
    + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/en/1.13.0/site-config.html b/docs/en/1.13.0/site-config.html index 1d310499e9..367dbc714e 100644 --- a/docs/en/1.13.0/site-config.html +++ b/docs/en/1.13.0/site-config.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -301,12 +301,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.13.0/site-config/index.html b/docs/en/1.13.0/site-config/index.html index 1d310499e9..367dbc714e 100644 --- a/docs/en/1.13.0/site-config/index.html +++ b/docs/en/1.13.0/site-config/index.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -301,12 +301,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.13.0/translation.html b/docs/en/1.13.0/translation.html index 6da1d14ce4..8a81625313 100644 --- a/docs/en/1.13.0/translation.html +++ b/docs/en/1.13.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Hosting on ZEIT Now

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

diff --git a/docs/en/1.9.x/site-config.html b/docs/en/1.9.x/site-config.html index c93551f06b..efd1047eb2 100644 --- a/docs/en/1.9.x/site-config.html +++ b/docs/en/1.9.x/site-config.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -289,12 +289,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.9.x/site-config/index.html b/docs/en/1.9.x/site-config/index.html index c93551f06b..efd1047eb2 100644 --- a/docs/en/1.9.x/site-config/index.html +++ b/docs/en/1.9.x/site-config/index.html @@ -206,17 +206,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -224,10 +224,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -289,12 +289,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/1.9.x/translation.html b/docs/en/1.9.x/translation.html index 8ea8356345..7ba023fc80 100644 --- a/docs/en/1.9.x/translation.html +++ b/docs/en/1.9.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2018-11-28 by Dom Corvasce

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2018-11-28 by Dom Corvasce
Docusaurus
Docs
Put the Site Online

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

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

-
const siteConfig = {
-  ...
+
const siteConfig = {
+  ...
   url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
   baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
   projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
   organizationName: 'USERNAME' // Your GitHub username.
-  ...
+  ...
 }
 
    diff --git a/docs/en/1.9.x/tutorial-publish-site/index.html b/docs/en/1.9.x/tutorial-publish-site/index.html index de64639ab7..6a0b391787 100644 --- a/docs/en/1.9.x/tutorial-publish-site/index.html +++ b/docs/en/1.9.x/tutorial-publish-site/index.html @@ -85,13 +85,13 @@

    Put the Site Online

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

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

    -
    const siteConfig = {
    -  ...
    +
    const siteConfig = {
    +  ...
       url: 'https://USERNAME.github.io', // Replace USERNAME with your GitHub username.
       baseUrl: '/docusaurus-tutorial/', // The name of your GitHub project.
       projectName: 'docusaurus-tutorial',  // The name of your GitHub project. Same as above.
       organizationName: 'USERNAME' // Your GitHub username.
    -  ...
    +  ...
     }
     
      diff --git a/docs/en/adding-blog.html b/docs/en/adding-blog.html index 7b6ecb975d..295e28c877 100644 --- a/docs/en/adding-blog.html +++ b/docs/en/adding-blog.html @@ -95,7 +95,7 @@
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/adding-blog/index.html b/docs/en/adding-blog/index.html
      index 7b6ecb975d..295e28c877 100644
      --- a/docs/en/adding-blog/index.html
      +++ b/docs/en/adding-blog/index.html
      @@ -95,7 +95,7 @@
       
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/doc-markdown.html b/docs/en/doc-markdown.html
      index 4536a4d3db..bea114fee5 100644
      --- a/docs/en/doc-markdown.html
      +++ b/docs/en/doc-markdown.html
      @@ -112,7 +112,7 @@
       
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -125,7 +125,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/doc-markdown/index.html b/docs/en/doc-markdown/index.html index 4536a4d3db..bea114fee5 100644 --- a/docs/en/doc-markdown/index.html +++ b/docs/en/doc-markdown/index.html @@ -112,7 +112,7 @@
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -125,7 +125,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/docker.html b/docs/en/docker.html index 9e20cbc4ae..754bc65e52 100644 --- a/docs/en/docker.html +++ b/docs/en/docker.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/docker/index.html b/docs/en/docker/index.html index 9e20cbc4ae..754bc65e52 100644 --- a/docs/en/docker/index.html +++ b/docs/en/docker/index.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/next/adding-blog.html b/docs/en/next/adding-blog.html index d63f477a8f..345ffae236 100644 --- a/docs/en/next/adding-blog.html +++ b/docs/en/next/adding-blog.html @@ -95,7 +95,7 @@
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/next/adding-blog/index.html b/docs/en/next/adding-blog/index.html
      index d63f477a8f..345ffae236 100644
      --- a/docs/en/next/adding-blog/index.html
      +++ b/docs/en/next/adding-blog/index.html
      @@ -95,7 +95,7 @@
       
      ---
       title: Introducing Docusaurus
       author: Joel Marcey
      -authorURL: http://twitter.com/JoelMarcey
      +authorURL: http://twitter.com/JoelMarcey
       authorFBID: 611217057
       authorTwitter: JoelMarcey
       ---
      diff --git a/docs/en/next/doc-markdown.html b/docs/en/next/doc-markdown.html
      index 0771c039cf..40525fb643 100644
      --- a/docs/en/next/doc-markdown.html
      +++ b/docs/en/next/doc-markdown.html
      @@ -112,7 +112,7 @@
       
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -125,7 +125,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/next/doc-markdown/index.html b/docs/en/next/doc-markdown/index.html index 0771c039cf..40525fb643 100644 --- a/docs/en/next/doc-markdown/index.html +++ b/docs/en/next/doc-markdown/index.html @@ -112,7 +112,7 @@
      ---
       id: doc-markdown
       title: Markdown Features
      -custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
      +custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
       ---
       

      Blog Posts

      @@ -125,7 +125,7 @@
      ---
       title: My First Blog Post
       author: Frank Li
      -authorURL: http://twitter.com/franchementli
      +authorURL: http://twitter.com/franchementli
       authorFBID: 100002976521003
       ---
       
      diff --git a/docs/en/next/docker.html b/docs/en/next/docker.html index 4aaa044027..06715269cb 100644 --- a/docs/en/next/docker.html +++ b/docs/en/next/docker.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/next/docker/index.html b/docs/en/next/docker/index.html index 4aaa044027..06715269cb 100644 --- a/docs/en/next/docker/index.html +++ b/docs/en/next/docker/index.html @@ -108,21 +108,21 @@
      version: "3"
       
       services:
      -  docusaurus:
      -    build: .
      -    ports:
      -      - 3000:3000
      -      - 35729:35729
      -    volumes:
      -      - ./docs:/app/docs
      -      - ./website/blog:/app/website/blog
      -      - ./website/core:/app/website/core
      -      - ./website/i18n:/app/website/i18n
      -      - ./website/pages:/app/website/pages
      -      - ./website/static:/app/website/static
      -      - ./website/sidebars.json:/app/website/sidebars.json
      -      - ./website/siteConfig.js:/app/website/siteConfig.js
      -    working_dir: /app/website
      +  docusaurus:
      +    build: .
      +    ports:
      +      - 3000:3000
      +      - 35729:35729
      +    volumes:
      +      - ./docs:/app/docs
      +      - ./website/blog:/app/website/blog
      +      - ./website/core:/app/website/core
      +      - ./website/i18n:/app/website/i18n
      +      - ./website/pages:/app/website/pages
      +      - ./website/static:/app/website/static
      +      - ./website/sidebars.json:/app/website/sidebars.json
      +      - ./website/siteConfig.js:/app/website/siteConfig.js
      +    working_dir: /app/website
       
       

      To run a local web server with docker-compose run docker-compose up.

      diff --git a/docs/en/next/publishing.html b/docs/en/next/publishing.html index c491a4f0c6..7d3785c2d4 100644 --- a/docs/en/next/publishing.html +++ b/docs/en/next/publishing.html @@ -142,7 +142,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -213,26 +213,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -264,12 +264,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

      Using Travis CI

      @@ -283,18 +283,18 @@ e.g.
      # .travis.yml
       language: node_js
       node_js:
      -  - '8'
      +  - '8'
       branches:
      -  only:
      -    - master
      +  only:
      +    - master
       cache:
      -  yarn: true
      +  yarn: true
       script:
      -  - git config --global user.name "${GH_NAME}"
      -  - git config --global user.email "${GH_EMAIL}"
      -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
      -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
      -
      + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

      Hosting on ZEIT Now

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

      diff --git a/docs/en/next/publishing/index.html b/docs/en/next/publishing/index.html index c491a4f0c6..7d3785c2d4 100644 --- a/docs/en/next/publishing/index.html +++ b/docs/en/next/publishing/index.html @@ -142,7 +142,7 @@
      const siteConfig = {
         ...
         url: 'https://__userName__.github.io', // Your website URL
      -  baseUrl: '/testProject/',
      +  baseUrl: '/testProject/',
         projectName: 'testProject',
         organizationName: 'userName'
         ...
      @@ -213,26 +213,26 @@
       
       version: 2
       jobs:
      -  deploy-website:
      -    docker:
      +  deploy-website:
      +    docker:
             # specify the version you desire here
      -      - image: circleci/node:8.11.1
      +      - image: circleci/node:8.11.1
       
      -    steps:
      -      - checkout
      -      - run:
      -          name: Deploying to GitHub Pages
      -          command: |
      +    steps:
      +      - checkout
      +      - run:
      +          name: Deploying to GitHub Pages
      +          command: |
                   git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
                   git config --global user.name "<YOUR_NAME>"
                   echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
                   cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
      -
      -workflows:
      -  version: 2
      -  build_and_deploy:
      -    jobs:
      -      - deploy-website:
      +
      +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.

      @@ -264,12 +264,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

      Using Travis CI

      @@ -283,18 +283,18 @@ e.g.
      # .travis.yml
       language: node_js
       node_js:
      -  - '8'
      +  - '8'
       branches:
      -  only:
      -    - master
      +  only:
      +    - master
       cache:
      -  yarn: true
      +  yarn: true
       script:
      -  - git config --global user.name "${GH_NAME}"
      -  - git config --global user.email "${GH_EMAIL}"
      -  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
      -  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
      -
      + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

      Hosting on ZEIT Now

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

      diff --git a/docs/en/next/site-config.html b/docs/en/next/site-config.html index 7e6bfb53c8..3d390c5504 100644 --- a/docs/en/next/site-config.html +++ b/docs/en/next/site-config.html @@ -209,17 +209,17 @@ If unset, it is defaulted to docs.

      Syntax highlighting options:

      {
         // ...
      -  highlight: {
      +  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',
      +    theme: 'default',
       
           // The particular version of Highlight.js to be used.
      -    version: '9.12.0',
      +    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) {
      +    hljs: function(highlightJsInstance) {
             // do something here
           },
       
      @@ -227,10 +227,10 @@ If unset, it is defaulted to docs.

      // 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
      @@ -312,12 +312,12 @@ If unset, it is defaulted to docs.

      // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/next/site-config/index.html b/docs/en/next/site-config/index.html index 7e6bfb53c8..3d390c5504 100644 --- a/docs/en/next/site-config/index.html +++ b/docs/en/next/site-config/index.html @@ -209,17 +209,17 @@ If unset, it is defaulted to docs.

      Syntax highlighting options:

      {
         // ...
      -  highlight: {
      +  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',
      +    theme: 'default',
       
           // The particular version of Highlight.js to be used.
      -    version: '9.12.0',
      +    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) {
      +    hljs: function(highlightJsInstance) {
             // do something here
           },
       
      @@ -227,10 +227,10 @@ If unset, it is defaulted to docs.

      // 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
      @@ -312,12 +312,12 @@ If unset, it is defaulted to docs.

      // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/next/translation.html b/docs/en/next/translation.html index f1e76c8dac..97c4e40c9a 100644 --- a/docs/en/next/translation.html +++ b/docs/en/next/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

    Setup the Crowdin Scripts

    @@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Hosting on ZEIT Now

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

diff --git a/docs/en/publishing/index.html b/docs/en/publishing/index.html index 3cd6ac1fc3..c2ea90c1ec 100644 --- a/docs/en/publishing/index.html +++ b/docs/en/publishing/index.html @@ -142,7 +142,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -209,26 +209,26 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+    steps:
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
-
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-      - deploy-website:
+
+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.

@@ -260,12 +260,12 @@ e.g. # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -279,18 +279,18 @@ e.g.
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/en/site-config.html b/docs/en/site-config.html index 5d806daaf0..e9cb709a6f 100644 --- a/docs/en/site-config.html +++ b/docs/en/site-config.html @@ -209,17 +209,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -227,10 +227,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -312,12 +312,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/site-config/index.html b/docs/en/site-config/index.html index 5d806daaf0..e9cb709a6f 100644 --- a/docs/en/site-config/index.html +++ b/docs/en/site-config/index.html @@ -209,17 +209,17 @@ If unset, it is defaulted to docs.

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -227,10 +227,10 @@ If unset, it is defaulted to docs.

// 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', + 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' + themeUrl: 'http://foo.bar/custom.css' }, }
@@ -312,12 +312,12 @@ If unset, it is defaulted to docs.

// For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/en/translation.html b/docs/en/translation.html index 61b3dba0f1..5e82a3b70b 100644 --- a/docs/en/translation.html +++ b/docs/en/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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

Setup the Crowdin Scripts

@@ -263,16 +263,16 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -287,12 +287,12 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages - -workflows: - version: 2 - build_and_deploy: - jobs: - - deploy-website: + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: # filters: *filter-only-master

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

@@ -301,10 +301,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Last updated on 2019-5-17 by Hongarc

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.

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.10.x/site-config.html b/docs/fr/1.10.x/site-config.html index 93320967db..8ac7939671 100644 --- a/docs/fr/1.10.x/site-config.html +++ b/docs/fr/1.10.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.10.x/site-config/index.html b/docs/fr/1.10.x/site-config/index.html index 93320967db..8ac7939671 100644 --- a/docs/fr/1.10.x/site-config/index.html +++ b/docs/fr/1.10.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.10.x/translation.html b/docs/fr/1.10.x/translation.html index 096c36265e..ab6a380d1f 100644 --- a/docs/fr/1.10.x/translation.html +++ b/docs/fr/1.10.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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.

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.11.x/publishing/index.html b/docs/fr/1.11.x/publishing/index.html index 78f0a9688e..139d8aca2d 100644 --- a/docs/fr/1.11.x/publishing/index.html +++ b/docs/fr/1.11.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.11.x/site-config.html b/docs/fr/1.11.x/site-config.html index ad54e95fb6..b913c2c3b1 100644 --- a/docs/fr/1.11.x/site-config.html +++ b/docs/fr/1.11.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.11.x/site-config/index.html b/docs/fr/1.11.x/site-config/index.html index ad54e95fb6..b913c2c3b1 100644 --- a/docs/fr/1.11.x/site-config/index.html +++ b/docs/fr/1.11.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.11.x/translation.html b/docs/fr/1.11.x/translation.html index 78b3994027..86081e274c 100644 --- a/docs/fr/1.11.x/translation.html +++ b/docs/fr/1.11.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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.

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.12.0/publishing/index.html b/docs/fr/1.12.0/publishing/index.html index d7e99dd348..0a3c99de6b 100644 --- a/docs/fr/1.12.0/publishing/index.html +++ b/docs/fr/1.12.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.12.0/site-config.html b/docs/fr/1.12.0/site-config.html index 8c9f39bd1b..6520ff3a27 100644 --- a/docs/fr/1.12.0/site-config.html +++ b/docs/fr/1.12.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.12.0/site-config/index.html b/docs/fr/1.12.0/site-config/index.html index 8c9f39bd1b..6520ff3a27 100644 --- a/docs/fr/1.12.0/site-config/index.html +++ b/docs/fr/1.12.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.12.0/translation.html b/docs/fr/1.12.0/translation.html index 7531fe5fda..576a222217 100644 --- a/docs/fr/1.12.0/translation.html +++ b/docs/fr/1.12.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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.

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.13.0/publishing/index.html b/docs/fr/1.13.0/publishing/index.html index 9870e49e3c..700b126eb3 100644 --- a/docs/fr/1.13.0/publishing/index.html +++ b/docs/fr/1.13.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.13.0/site-config.html b/docs/fr/1.13.0/site-config.html index 4b08cdd7ca..443cf58803 100644 --- a/docs/fr/1.13.0/site-config.html +++ b/docs/fr/1.13.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.13.0/site-config/index.html b/docs/fr/1.13.0/site-config/index.html index 4b08cdd7ca..443cf58803 100644 --- a/docs/fr/1.13.0/site-config/index.html +++ b/docs/fr/1.13.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.13.0/translation.html b/docs/fr/1.13.0/translation.html index 3fa4ed5f09..0dcf8f74c1 100644 --- a/docs/fr/1.13.0/translation.html +++ b/docs/fr/1.13.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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.

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.9.x/publishing/index.html b/docs/fr/1.9.x/publishing/index.html index 67d9adfd75..8e4a5a483f 100644 --- a/docs/fr/1.9.x/publishing/index.html +++ b/docs/fr/1.9.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/1.9.x/site-config.html b/docs/fr/1.9.x/site-config.html index 79e93899b0..49e2b3af83 100644 --- a/docs/fr/1.9.x/site-config.html +++ b/docs/fr/1.9.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.9.x/site-config/index.html b/docs/fr/1.9.x/site-config/index.html index 79e93899b0..49e2b3af83 100644 --- a/docs/fr/1.9.x/site-config/index.html +++ b/docs/fr/1.9.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/1.9.x/translation.html b/docs/fr/1.9.x/translation.html index e66ddfdc21..b26ec66de8 100644 --- a/docs/fr/1.9.x/translation.html +++ b/docs/fr/1.9.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/fr/adding-blog/index.html b/docs/fr/adding-blog/index.html index c85106d726..001a08755c 100644 --- a/docs/fr/adding-blog/index.html +++ b/docs/fr/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/fr/doc-markdown.html b/docs/fr/doc-markdown.html
index 2bd2a90624..4b68ed840d 100644
--- a/docs/fr/doc-markdown.html
+++ b/docs/fr/doc-markdown.html
@@ -93,9 +93,9 @@
 
 

Par exemple :

---
-id : doc1
-titre : Mon Document
-sidebar_label : Document
+id : doc1
+titre : Mon Document
+sidebar_label : Document
 ---
 

Versioned documents have their ids altered to include the version number when they get copied. The new id is version-${version}-${id} where ${version} is the version number of that document and ${id} is the original id. Additionally, versioned documents get an added original_id field with the original document id.

@@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Fonctionnalités de Markdown
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Publications de blog

@@ -125,7 +125,7 @@
---
 title: Mon premier post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/fr/doc-markdown/index.html b/docs/fr/doc-markdown/index.html index 2bd2a90624..4b68ed840d 100644 --- a/docs/fr/doc-markdown/index.html +++ b/docs/fr/doc-markdown/index.html @@ -93,9 +93,9 @@

Par exemple :

---
-id : doc1
-titre : Mon Document
-sidebar_label : Document
+id : doc1
+titre : Mon Document
+sidebar_label : Document
 ---
 

Versioned documents have their ids altered to include the version number when they get copied. The new id is version-${version}-${id} where ${version} is the version number of that document and ${id} is the original id. Additionally, versioned documents get an added original_id field with the original document id.

@@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Fonctionnalités de Markdown
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Publications de blog

@@ -125,7 +125,7 @@
---
 title: Mon premier post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/fr/docker.html b/docs/fr/docker.html index 1e10680541..d09c97b1e3 100644 --- a/docs/fr/docker.html +++ b/docs/fr/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

Pour exécuter un serveur web local avec docker-compose, exécutez docker-compose up.

diff --git a/docs/fr/docker/index.html b/docs/fr/docker/index.html index 1e10680541..d09c97b1e3 100644 --- a/docs/fr/docker/index.html +++ b/docs/fr/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

Pour exécuter un serveur web local avec docker-compose, exécutez docker-compose up.

diff --git a/docs/fr/next/adding-blog.html b/docs/fr/next/adding-blog.html index 81152aa218..b969c8f545 100644 --- a/docs/fr/next/adding-blog.html +++ b/docs/fr/next/adding-blog.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/fr/next/adding-blog/index.html b/docs/fr/next/adding-blog/index.html
index 81152aa218..b969c8f545 100644
--- a/docs/fr/next/adding-blog/index.html
+++ b/docs/fr/next/adding-blog/index.html
@@ -95,7 +95,7 @@
 
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/fr/next/doc-markdown.html b/docs/fr/next/doc-markdown.html
index 4bc251dd77..b528dc73c8 100644
--- a/docs/fr/next/doc-markdown.html
+++ b/docs/fr/next/doc-markdown.html
@@ -93,9 +93,9 @@
 
 

Par exemple :

---
-id : doc1
-titre : Mon Document
-sidebar_label : Document
+id : doc1
+titre : Mon Document
+sidebar_label : Document
 ---
 

Versioned documents have their ids altered to include the version number when they get copied. The new id is version-${version}-${id} where ${version} is the version number of that document and ${id} is the original id. Additionally, versioned documents get an added original_id field with the original document id.

@@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Fonctionnalités de Markdown
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Publications de blog

@@ -125,7 +125,7 @@
---
 title: Mon premier post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/fr/next/doc-markdown/index.html b/docs/fr/next/doc-markdown/index.html index 4bc251dd77..b528dc73c8 100644 --- a/docs/fr/next/doc-markdown/index.html +++ b/docs/fr/next/doc-markdown/index.html @@ -93,9 +93,9 @@

Par exemple :

---
-id : doc1
-titre : Mon Document
-sidebar_label : Document
+id : doc1
+titre : Mon Document
+sidebar_label : Document
 ---
 

Versioned documents have their ids altered to include the version number when they get copied. The new id is version-${version}-${id} where ${version} is the version number of that document and ${id} is the original id. Additionally, versioned documents get an added original_id field with the original document id.

@@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Fonctionnalités de Markdown
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Publications de blog

@@ -125,7 +125,7 @@
---
 title: Mon premier post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/fr/next/docker.html b/docs/fr/next/docker.html index ded2de907f..31f2f19f02 100644 --- a/docs/fr/next/docker.html +++ b/docs/fr/next/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

Pour exécuter un serveur web local avec docker-compose, exécutez docker-compose up.

diff --git a/docs/fr/next/docker/index.html b/docs/fr/next/docker/index.html index ded2de907f..31f2f19f02 100644 --- a/docs/fr/next/docker/index.html +++ b/docs/fr/next/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

Pour exécuter un serveur web local avec docker-compose, exécutez docker-compose up.

diff --git a/docs/fr/next/publishing.html b/docs/fr/next/publishing.html index e88e9aa395..4dcfe79327 100644 --- a/docs/fr/next/publishing.html +++ b/docs/fr/next/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/next/publishing/index.html b/docs/fr/next/publishing/index.html index e88e9aa395..4dcfe79327 100644 --- a/docs/fr/next/publishing/index.html +++ b/docs/fr/next/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/next/site-config.html b/docs/fr/next/site-config.html index 6c05f14f9b..c960ba0c69 100644 --- a/docs/fr/next/site-config.html +++ b/docs/fr/next/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/next/site-config/index.html b/docs/fr/next/site-config/index.html index 6c05f14f9b..c960ba0c69 100644 --- a/docs/fr/next/site-config/index.html +++ b/docs/fr/next/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/next/translation.html b/docs/fr/next/translation.html index c6aec028ea..295c153893 100644 --- a/docs/fr/next/translation.html +++ b/docs/fr/next/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/publishing/index.html b/docs/fr/publishing/index.html index 107a3f6b1a..58ad51d754 100644 --- a/docs/fr/publishing/index.html +++ b/docs/fr/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Assurez-vous de remplacer tous les <....> dans la commande: avec des valeurs appropriées. Pour <GIT_USER>, c'est un compte GitHub qui a accès à la documentation pour push dans votre dépôt GitHub. De nombreuses fois <GIT_USER> et <GITHUB_USERNAME> seront les mêmes.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hébergement sur ZEIT now

Avec ZEIT Now, vous pouvez déployer votre site facilement et le connecter à GitHub ou GitLab pour recevoir automatiquement un nouveau déploiement à chaque fois que vous pousser un commit.

diff --git a/docs/fr/site-config.html b/docs/fr/site-config.html index 3486be490d..4d6271dd5f 100644 --- a/docs/fr/site-config.html +++ b/docs/fr/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/site-config/index.html b/docs/fr/site-config/index.html index 3486be490d..4d6271dd5f 100644 --- a/docs/fr/site-config/index.html +++ b/docs/fr/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/fr/translation.html b/docs/fr/translation.html index 3a6e564e97..a464453ac7 100644 --- a/docs/fr/translation.html +++ b/docs/fr/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

Versioned Translations

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ko/1.10.x/adding-blog/index.html b/docs/ko/1.10.x/adding-blog/index.html index 0a29d47f05..301fbaa9fa 100644 --- a/docs/ko/1.10.x/adding-blog/index.html +++ b/docs/ko/1.10.x/adding-blog/index.html @@ -94,7 +94,7 @@

예를 들어 website/blog/2017-08-18-Introducing-Docusaurus.md 파일은 이렇게 시작합니다.

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ko/1.10.x/doc-markdown.html b/docs/ko/1.10.x/doc-markdown.html
index cae10576c3..6cc1fa78ad 100644
--- a/docs/ko/1.10.x/doc-markdown.html
+++ b/docs/ko/1.10.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.10.x/doc-markdown/index.html b/docs/ko/1.10.x/doc-markdown/index.html index cae10576c3..6cc1fa78ad 100644 --- a/docs/ko/1.10.x/doc-markdown/index.html +++ b/docs/ko/1.10.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.10.x/docker.html b/docs/ko/1.10.x/docker.html index eda9a0b584..6979b611d7 100644 --- a/docs/ko/1.10.x/docker.html +++ b/docs/ko/1.10.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.10.x/docker/index.html b/docs/ko/1.10.x/docker/index.html index eda9a0b584..6979b611d7 100644 --- a/docs/ko/1.10.x/docker/index.html +++ b/docs/ko/1.10.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.10.x/publishing.html b/docs/ko/1.10.x/publishing.html index ed52951ef7..b564c87ea2 100644 --- a/docs/ko/1.10.x/publishing.html +++ b/docs/ko/1.10.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.10.x/publishing/index.html b/docs/ko/1.10.x/publishing/index.html index ed52951ef7..b564c87ea2 100644 --- a/docs/ko/1.10.x/publishing/index.html +++ b/docs/ko/1.10.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.10.x/site-config.html b/docs/ko/1.10.x/site-config.html index 922c51d4df..3bb68c236e 100644 --- a/docs/ko/1.10.x/site-config.html +++ b/docs/ko/1.10.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.10.x/site-config/index.html b/docs/ko/1.10.x/site-config/index.html index 922c51d4df..3bb68c236e 100644 --- a/docs/ko/1.10.x/site-config/index.html +++ b/docs/ko/1.10.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.10.x/translation.html b/docs/ko/1.10.x/translation.html index 5f76dbaf43..3c87cb623d 100644 --- a/docs/ko/1.10.x/translation.html +++ b/docs/ko/1.10.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ko/1.11.x/adding-blog/index.html b/docs/ko/1.11.x/adding-blog/index.html index 724bbfd74c..6cd559f35e 100644 --- a/docs/ko/1.11.x/adding-blog/index.html +++ b/docs/ko/1.11.x/adding-blog/index.html @@ -94,7 +94,7 @@

예를 들어 website/blog/2017-08-18-Introducing-Docusaurus.md 파일은 이렇게 시작합니다.

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ko/1.11.x/doc-markdown.html b/docs/ko/1.11.x/doc-markdown.html
index 2d6dcbe78e..e14e9d85ba 100644
--- a/docs/ko/1.11.x/doc-markdown.html
+++ b/docs/ko/1.11.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.11.x/doc-markdown/index.html b/docs/ko/1.11.x/doc-markdown/index.html index 2d6dcbe78e..e14e9d85ba 100644 --- a/docs/ko/1.11.x/doc-markdown/index.html +++ b/docs/ko/1.11.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.11.x/docker.html b/docs/ko/1.11.x/docker.html index c5fc538898..11d7699811 100644 --- a/docs/ko/1.11.x/docker.html +++ b/docs/ko/1.11.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.11.x/docker/index.html b/docs/ko/1.11.x/docker/index.html index c5fc538898..11d7699811 100644 --- a/docs/ko/1.11.x/docker/index.html +++ b/docs/ko/1.11.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.11.x/publishing.html b/docs/ko/1.11.x/publishing.html index e45d0fdc1d..9bacd5ce60 100644 --- a/docs/ko/1.11.x/publishing.html +++ b/docs/ko/1.11.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.11.x/publishing/index.html b/docs/ko/1.11.x/publishing/index.html index e45d0fdc1d..9bacd5ce60 100644 --- a/docs/ko/1.11.x/publishing/index.html +++ b/docs/ko/1.11.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.11.x/site-config.html b/docs/ko/1.11.x/site-config.html index d6f80ff544..70491aeeaf 100644 --- a/docs/ko/1.11.x/site-config.html +++ b/docs/ko/1.11.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.11.x/site-config/index.html b/docs/ko/1.11.x/site-config/index.html index d6f80ff544..70491aeeaf 100644 --- a/docs/ko/1.11.x/site-config/index.html +++ b/docs/ko/1.11.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.11.x/translation.html b/docs/ko/1.11.x/translation.html index b243030c22..5b85ad9571 100644 --- a/docs/ko/1.11.x/translation.html +++ b/docs/ko/1.11.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ko/1.12.0/adding-blog/index.html b/docs/ko/1.12.0/adding-blog/index.html index 714eefd03f..4d288bfae4 100644 --- a/docs/ko/1.12.0/adding-blog/index.html +++ b/docs/ko/1.12.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ko/1.12.0/doc-markdown.html b/docs/ko/1.12.0/doc-markdown.html
index 0fac493a88..efc0dea2cf 100644
--- a/docs/ko/1.12.0/doc-markdown.html
+++ b/docs/ko/1.12.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.12.0/doc-markdown/index.html b/docs/ko/1.12.0/doc-markdown/index.html index 0fac493a88..efc0dea2cf 100644 --- a/docs/ko/1.12.0/doc-markdown/index.html +++ b/docs/ko/1.12.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.12.0/docker.html b/docs/ko/1.12.0/docker.html index 0402f8198a..5243a928fd 100644 --- a/docs/ko/1.12.0/docker.html +++ b/docs/ko/1.12.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.12.0/docker/index.html b/docs/ko/1.12.0/docker/index.html index 0402f8198a..5243a928fd 100644 --- a/docs/ko/1.12.0/docker/index.html +++ b/docs/ko/1.12.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.12.0/publishing.html b/docs/ko/1.12.0/publishing.html index 75bf4fa355..4558399ca7 100644 --- a/docs/ko/1.12.0/publishing.html +++ b/docs/ko/1.12.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.12.0/publishing/index.html b/docs/ko/1.12.0/publishing/index.html index 75bf4fa355..4558399ca7 100644 --- a/docs/ko/1.12.0/publishing/index.html +++ b/docs/ko/1.12.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.12.0/site-config.html b/docs/ko/1.12.0/site-config.html index d7b18acc2f..6a8fa01c6d 100644 --- a/docs/ko/1.12.0/site-config.html +++ b/docs/ko/1.12.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.12.0/site-config/index.html b/docs/ko/1.12.0/site-config/index.html index d7b18acc2f..6a8fa01c6d 100644 --- a/docs/ko/1.12.0/site-config/index.html +++ b/docs/ko/1.12.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.12.0/translation.html b/docs/ko/1.12.0/translation.html index cd95d1993f..33e07f2ae9 100644 --- a/docs/ko/1.12.0/translation.html +++ b/docs/ko/1.12.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ko/1.13.0/adding-blog/index.html b/docs/ko/1.13.0/adding-blog/index.html index e74c9a8d2a..12f150902b 100644 --- a/docs/ko/1.13.0/adding-blog/index.html +++ b/docs/ko/1.13.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ko/1.13.0/doc-markdown.html b/docs/ko/1.13.0/doc-markdown.html
index 032a09ec1d..029213321e 100644
--- a/docs/ko/1.13.0/doc-markdown.html
+++ b/docs/ko/1.13.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.13.0/doc-markdown/index.html b/docs/ko/1.13.0/doc-markdown/index.html index 032a09ec1d..029213321e 100644 --- a/docs/ko/1.13.0/doc-markdown/index.html +++ b/docs/ko/1.13.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.13.0/docker.html b/docs/ko/1.13.0/docker.html index 9627adc504..97014a0a1c 100644 --- a/docs/ko/1.13.0/docker.html +++ b/docs/ko/1.13.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.13.0/docker/index.html b/docs/ko/1.13.0/docker/index.html index 9627adc504..97014a0a1c 100644 --- a/docs/ko/1.13.0/docker/index.html +++ b/docs/ko/1.13.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.13.0/publishing.html b/docs/ko/1.13.0/publishing.html index 1715eb167b..4b10730caf 100644 --- a/docs/ko/1.13.0/publishing.html +++ b/docs/ko/1.13.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.13.0/publishing/index.html b/docs/ko/1.13.0/publishing/index.html index 1715eb167b..4b10730caf 100644 --- a/docs/ko/1.13.0/publishing/index.html +++ b/docs/ko/1.13.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.13.0/site-config.html b/docs/ko/1.13.0/site-config.html index f56112b2d0..0a774e255a 100644 --- a/docs/ko/1.13.0/site-config.html +++ b/docs/ko/1.13.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.13.0/site-config/index.html b/docs/ko/1.13.0/site-config/index.html index f56112b2d0..0a774e255a 100644 --- a/docs/ko/1.13.0/site-config/index.html +++ b/docs/ko/1.13.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.13.0/translation.html b/docs/ko/1.13.0/translation.html index 92472f4efb..a7306c3d97 100644 --- a/docs/ko/1.13.0/translation.html +++ b/docs/ko/1.13.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ko/1.9.x/adding-blog/index.html b/docs/ko/1.9.x/adding-blog/index.html index 9aa4015abb..3531650881 100644 --- a/docs/ko/1.9.x/adding-blog/index.html +++ b/docs/ko/1.9.x/adding-blog/index.html @@ -94,7 +94,7 @@

예를 들어 website/blog/2017-08-18-Introducing-Docusaurus.md 파일은 이렇게 시작합니다.

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ko/1.9.x/doc-markdown.html b/docs/ko/1.9.x/doc-markdown.html
index b141067bd9..e36d79f469 100644
--- a/docs/ko/1.9.x/doc-markdown.html
+++ b/docs/ko/1.9.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.9.x/doc-markdown/index.html b/docs/ko/1.9.x/doc-markdown/index.html index b141067bd9..e36d79f469 100644 --- a/docs/ko/1.9.x/doc-markdown/index.html +++ b/docs/ko/1.9.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -122,7 +122,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/1.9.x/docker.html b/docs/ko/1.9.x/docker.html index 5498420e16..086eca72a3 100644 --- a/docs/ko/1.9.x/docker.html +++ b/docs/ko/1.9.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.9.x/docker/index.html b/docs/ko/1.9.x/docker/index.html index 5498420e16..086eca72a3 100644 --- a/docs/ko/1.9.x/docker/index.html +++ b/docs/ko/1.9.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/1.9.x/publishing.html b/docs/ko/1.9.x/publishing.html index d49daa17dd..5016b89667 100644 --- a/docs/ko/1.9.x/publishing.html +++ b/docs/ko/1.9.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.9.x/publishing/index.html b/docs/ko/1.9.x/publishing/index.html index d49daa17dd..5016b89667 100644 --- a/docs/ko/1.9.x/publishing/index.html +++ b/docs/ko/1.9.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/1.9.x/site-config.html b/docs/ko/1.9.x/site-config.html index 1fc55d33e8..f758492823 100644 --- a/docs/ko/1.9.x/site-config.html +++ b/docs/ko/1.9.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.9.x/site-config/index.html b/docs/ko/1.9.x/site-config/index.html index 1fc55d33e8..f758492823 100644 --- a/docs/ko/1.9.x/site-config/index.html +++ b/docs/ko/1.9.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/1.9.x/translation.html b/docs/ko/1.9.x/translation.html index e8ff3d14f2..f8c5f2d480 100644 --- a/docs/ko/1.9.x/translation.html +++ b/docs/ko/1.9.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ko/adding-blog/index.html b/docs/ko/adding-blog/index.html index cd57a3d3bb..ca9e7a9df8 100644 --- a/docs/ko/adding-blog/index.html +++ b/docs/ko/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ko/doc-markdown.html b/docs/ko/doc-markdown.html
index d1e3ae7d23..107f5ad60f 100644
--- a/docs/ko/doc-markdown.html
+++ b/docs/ko/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -125,7 +125,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/doc-markdown/index.html b/docs/ko/doc-markdown/index.html index d1e3ae7d23..107f5ad60f 100644 --- a/docs/ko/doc-markdown/index.html +++ b/docs/ko/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -125,7 +125,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/docker.html b/docs/ko/docker.html index 68d07cbdd4..c80d014fd0 100644 --- a/docs/ko/docker.html +++ b/docs/ko/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/docker/index.html b/docs/ko/docker/index.html index 68d07cbdd4..c80d014fd0 100644 --- a/docs/ko/docker/index.html +++ b/docs/ko/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/next/adding-blog.html b/docs/ko/next/adding-blog.html index c08188f7ed..4265c156d6 100644 --- a/docs/ko/next/adding-blog.html +++ b/docs/ko/next/adding-blog.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ko/next/adding-blog/index.html b/docs/ko/next/adding-blog/index.html
index c08188f7ed..4265c156d6 100644
--- a/docs/ko/next/adding-blog/index.html
+++ b/docs/ko/next/adding-blog/index.html
@@ -95,7 +95,7 @@
 
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ko/next/doc-markdown.html b/docs/ko/next/doc-markdown.html
index 8f0bafea51..7efb86d6a7 100644
--- a/docs/ko/next/doc-markdown.html
+++ b/docs/ko/next/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -125,7 +125,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/next/doc-markdown/index.html b/docs/ko/next/doc-markdown/index.html index 8f0bafea51..7efb86d6a7 100644 --- a/docs/ko/next/doc-markdown/index.html +++ b/docs/ko/next/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: 마크다운 기능
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

블로그 포스트

@@ -125,7 +125,7 @@
---
 title:  첫번째 블로그 포스트
 author: 프랭크 
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ko/next/docker.html b/docs/ko/next/docker.html index 72d10de12e..73724c7b88 100644 --- a/docs/ko/next/docker.html +++ b/docs/ko/next/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/next/docker/index.html b/docs/ko/next/docker/index.html index 72d10de12e..73724c7b88 100644 --- a/docs/ko/next/docker/index.html +++ b/docs/ko/next/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ko/next/publishing.html b/docs/ko/next/publishing.html index b52de0b316..3ffc63e4c8 100644 --- a/docs/ko/next/publishing.html +++ b/docs/ko/next/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/next/publishing/index.html b/docs/ko/next/publishing/index.html index b52de0b316..3ffc63e4c8 100644 --- a/docs/ko/next/publishing/index.html +++ b/docs/ko/next/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/next/site-config.html b/docs/ko/next/site-config.html index e69b2e0b0a..6ef1c87d76 100644 --- a/docs/ko/next/site-config.html +++ b/docs/ko/next/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/next/site-config/index.html b/docs/ko/next/site-config/index.html index e69b2e0b0a..6ef1c87d76 100644 --- a/docs/ko/next/site-config/index.html +++ b/docs/ko/next/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/next/translation.html b/docs/ko/next/translation.html index 1dc9a1bf92..0ee36dd84a 100644 --- a/docs/ko/next/translation.html +++ b/docs/ko/next/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/publishing/index.html b/docs/ko/publishing/index.html index d385d5182e..d1421f7596 100644 --- a/docs/ko/publishing/index.html +++ b/docs/ko/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

command: 항목에서 <....>로 표시된 부분은 적절한 값으로 변경해주어야 합니다. <GIT_USER> 항목은 GitHub 저장소에 문서를 집어넣기 위한 권한을 가지고 있는 GitHub 사용자 계정을 지정해줍니다. 대부분의 경우 <GIT_USER><GITHUB_USERNAME>은 같은 값을 사용합니다.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

config.yml 파일로 만들고 website/static 디렉토리 밑에 있는 .circleci 디렉토리 아래에 저장합니다.

Travis CI 사용하기

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

이제 master 브랜치에 새로운 커밋이 발생하게 되면 Travis CI는 여러분의 테스트 스위트가 실행되고 모든 테스트가 통과되면 publish-gh-pages 스크립트가 실행되어 여러분의 웹사이트를 배포하게 됩니다.

Hosting on ZEIT Now

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

diff --git a/docs/ko/site-config.html b/docs/ko/site-config.html index ddc82e6da9..08036df2d3 100644 --- a/docs/ko/site-config.html +++ b/docs/ko/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/site-config/index.html b/docs/ko/site-config/index.html index ddc82e6da9..08036df2d3 100644 --- a/docs/ko/site-config/index.html +++ b/docs/ko/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ko/translation.html b/docs/ko/translation.html index 4f1ad101dd..e868b6bb84 100644 --- a/docs/ko/translation.html +++ b/docs/ko/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

이미 번역된 문서 번역하기

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Apresentando o Docusaurus --- diff --git a/docs/pt-BR/1.10.x/adding-blog/index.html b/docs/pt-BR/1.10.x/adding-blog/index.html index d74c4b1468..d29b396ec7 100644 --- a/docs/pt-BR/1.10.x/adding-blog/index.html +++ b/docs/pt-BR/1.10.x/adding-blog/index.html @@ -94,7 +94,7 @@

Por exemplo, em website/blog/2017-08-18-Apresentando-o-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Apresentando o Docusaurus
 ---
diff --git a/docs/pt-BR/1.10.x/doc-markdown.html b/docs/pt-BR/1.10.x/doc-markdown.html
index 9774df63ca..c27c41eb14 100644
--- a/docs/pt-BR/1.10.x/doc-markdown.html
+++ b/docs/pt-BR/1.10.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.10.x/doc-markdown/index.html b/docs/pt-BR/1.10.x/doc-markdown/index.html index 9774df63ca..c27c41eb14 100644 --- a/docs/pt-BR/1.10.x/doc-markdown/index.html +++ b/docs/pt-BR/1.10.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.10.x/docker.html b/docs/pt-BR/1.10.x/docker.html index 4405590313..66255ea23b 100644 --- a/docs/pt-BR/1.10.x/docker.html +++ b/docs/pt-BR/1.10.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.10.x/docker/index.html b/docs/pt-BR/1.10.x/docker/index.html index 4405590313..66255ea23b 100644 --- a/docs/pt-BR/1.10.x/docker/index.html +++ b/docs/pt-BR/1.10.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.10.x/publishing.html b/docs/pt-BR/1.10.x/publishing.html index a820e8f94d..f4927d84ba 100644 --- a/docs/pt-BR/1.10.x/publishing.html +++ b/docs/pt-BR/1.10.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + 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.

Usando o Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.10.x/publishing/index.html b/docs/pt-BR/1.10.x/publishing/index.html index a820e8f94d..f4927d84ba 100644 --- a/docs/pt-BR/1.10.x/publishing/index.html +++ b/docs/pt-BR/1.10.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + 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.

Usando o Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.10.x/site-config.html b/docs/pt-BR/1.10.x/site-config.html index ddfdc09f58..ca4745b8e3 100644 --- a/docs/pt-BR/1.10.x/site-config.html +++ b/docs/pt-BR/1.10.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.10.x/site-config/index.html b/docs/pt-BR/1.10.x/site-config/index.html index ddfdc09f58..ca4745b8e3 100644 --- a/docs/pt-BR/1.10.x/site-config/index.html +++ b/docs/pt-BR/1.10.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.10.x/translation.html b/docs/pt-BR/1.10.x/translation.html index 52eee2cbef..7c06d74310 100644 --- a/docs/pt-BR/1.10.x/translation.html +++ b/docs/pt-BR/1.10.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Apresentando o Docusaurus --- diff --git a/docs/pt-BR/1.11.x/adding-blog/index.html b/docs/pt-BR/1.11.x/adding-blog/index.html index c6333f1eba..803369662b 100644 --- a/docs/pt-BR/1.11.x/adding-blog/index.html +++ b/docs/pt-BR/1.11.x/adding-blog/index.html @@ -94,7 +94,7 @@

Por exemplo, em website/blog/2017-08-18-Apresentando-o-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Apresentando o Docusaurus
 ---
diff --git a/docs/pt-BR/1.11.x/doc-markdown.html b/docs/pt-BR/1.11.x/doc-markdown.html
index cf387ba503..7ba18bd448 100644
--- a/docs/pt-BR/1.11.x/doc-markdown.html
+++ b/docs/pt-BR/1.11.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.11.x/doc-markdown/index.html b/docs/pt-BR/1.11.x/doc-markdown/index.html index cf387ba503..7ba18bd448 100644 --- a/docs/pt-BR/1.11.x/doc-markdown/index.html +++ b/docs/pt-BR/1.11.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.11.x/docker.html b/docs/pt-BR/1.11.x/docker.html index 4f924f195d..2140b14a89 100644 --- a/docs/pt-BR/1.11.x/docker.html +++ b/docs/pt-BR/1.11.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.11.x/docker/index.html b/docs/pt-BR/1.11.x/docker/index.html index 4f924f195d..2140b14a89 100644 --- a/docs/pt-BR/1.11.x/docker/index.html +++ b/docs/pt-BR/1.11.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.11.x/publishing.html b/docs/pt-BR/1.11.x/publishing.html index 91674b2097..40d32f35b8 100644 --- a/docs/pt-BR/1.11.x/publishing.html +++ b/docs/pt-BR/1.11.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + 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.

Usando o Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.11.x/publishing/index.html b/docs/pt-BR/1.11.x/publishing/index.html index 91674b2097..40d32f35b8 100644 --- a/docs/pt-BR/1.11.x/publishing/index.html +++ b/docs/pt-BR/1.11.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + 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.

Usando o Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.11.x/site-config.html b/docs/pt-BR/1.11.x/site-config.html index 00e6a9366b..e951934881 100644 --- a/docs/pt-BR/1.11.x/site-config.html +++ b/docs/pt-BR/1.11.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.11.x/site-config/index.html b/docs/pt-BR/1.11.x/site-config/index.html index 00e6a9366b..e951934881 100644 --- a/docs/pt-BR/1.11.x/site-config/index.html +++ b/docs/pt-BR/1.11.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.11.x/translation.html b/docs/pt-BR/1.11.x/translation.html index 7d0a1b306d..4e3b6c453a 100644 --- a/docs/pt-BR/1.11.x/translation.html +++ b/docs/pt-BR/1.11.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/pt-BR/1.12.0/adding-blog/index.html b/docs/pt-BR/1.12.0/adding-blog/index.html index 70d9de74be..786b22c650 100644 --- a/docs/pt-BR/1.12.0/adding-blog/index.html +++ b/docs/pt-BR/1.12.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/pt-BR/1.12.0/doc-markdown.html b/docs/pt-BR/1.12.0/doc-markdown.html
index b793822356..ccba590b7d 100644
--- a/docs/pt-BR/1.12.0/doc-markdown.html
+++ b/docs/pt-BR/1.12.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.12.0/doc-markdown/index.html b/docs/pt-BR/1.12.0/doc-markdown/index.html index b793822356..ccba590b7d 100644 --- a/docs/pt-BR/1.12.0/doc-markdown/index.html +++ b/docs/pt-BR/1.12.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.12.0/docker.html b/docs/pt-BR/1.12.0/docker.html index bd56b23180..be40642bbc 100644 --- a/docs/pt-BR/1.12.0/docker.html +++ b/docs/pt-BR/1.12.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.12.0/docker/index.html b/docs/pt-BR/1.12.0/docker/index.html index bd56b23180..be40642bbc 100644 --- a/docs/pt-BR/1.12.0/docker/index.html +++ b/docs/pt-BR/1.12.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.12.0/publishing.html b/docs/pt-BR/1.12.0/publishing.html index 2b4bc672bf..f96641d7e2 100644 --- a/docs/pt-BR/1.12.0/publishing.html +++ b/docs/pt-BR/1.12.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -208,29 +208,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -259,12 +259,12 @@ # 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" + 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.

Usando o Travis CI

@@ -278,18 +278,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.12.0/publishing/index.html b/docs/pt-BR/1.12.0/publishing/index.html index 2b4bc672bf..f96641d7e2 100644 --- a/docs/pt-BR/1.12.0/publishing/index.html +++ b/docs/pt-BR/1.12.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -208,29 +208,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -259,12 +259,12 @@ # 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" + 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.

Usando o Travis CI

@@ -278,18 +278,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.12.0/site-config.html b/docs/pt-BR/1.12.0/site-config.html index 6ba58722c5..47fa755b3a 100644 --- a/docs/pt-BR/1.12.0/site-config.html +++ b/docs/pt-BR/1.12.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.12.0/site-config/index.html b/docs/pt-BR/1.12.0/site-config/index.html index 6ba58722c5..47fa755b3a 100644 --- a/docs/pt-BR/1.12.0/site-config/index.html +++ b/docs/pt-BR/1.12.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.12.0/translation.html b/docs/pt-BR/1.12.0/translation.html index 4910592eaf..36f065be5e 100644 --- a/docs/pt-BR/1.12.0/translation.html +++ b/docs/pt-BR/1.12.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/pt-BR/1.13.0/adding-blog/index.html b/docs/pt-BR/1.13.0/adding-blog/index.html index c65dedf4a7..a4c10851a7 100644 --- a/docs/pt-BR/1.13.0/adding-blog/index.html +++ b/docs/pt-BR/1.13.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/pt-BR/1.13.0/doc-markdown.html b/docs/pt-BR/1.13.0/doc-markdown.html
index f6bc700eaf..6f21f12755 100644
--- a/docs/pt-BR/1.13.0/doc-markdown.html
+++ b/docs/pt-BR/1.13.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.13.0/doc-markdown/index.html b/docs/pt-BR/1.13.0/doc-markdown/index.html index f6bc700eaf..6f21f12755 100644 --- a/docs/pt-BR/1.13.0/doc-markdown/index.html +++ b/docs/pt-BR/1.13.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.13.0/docker.html b/docs/pt-BR/1.13.0/docker.html index d78b0b5e30..b941b78ac9 100644 --- a/docs/pt-BR/1.13.0/docker.html +++ b/docs/pt-BR/1.13.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.13.0/docker/index.html b/docs/pt-BR/1.13.0/docker/index.html index d78b0b5e30..b941b78ac9 100644 --- a/docs/pt-BR/1.13.0/docker/index.html +++ b/docs/pt-BR/1.13.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.13.0/publishing.html b/docs/pt-BR/1.13.0/publishing.html index 7d3e655704..b47e65ce5e 100644 --- a/docs/pt-BR/1.13.0/publishing.html +++ b/docs/pt-BR/1.13.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -208,29 +208,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -259,12 +259,12 @@ # 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" + 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.

Usando o Travis CI

@@ -278,18 +278,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.13.0/publishing/index.html b/docs/pt-BR/1.13.0/publishing/index.html index 7d3e655704..b47e65ce5e 100644 --- a/docs/pt-BR/1.13.0/publishing/index.html +++ b/docs/pt-BR/1.13.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -208,29 +208,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -259,12 +259,12 @@ # 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" + 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.

Usando o Travis CI

@@ -278,18 +278,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.13.0/site-config.html b/docs/pt-BR/1.13.0/site-config.html index c30382b2ea..7eb3d8a8ac 100644 --- a/docs/pt-BR/1.13.0/site-config.html +++ b/docs/pt-BR/1.13.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.13.0/site-config/index.html b/docs/pt-BR/1.13.0/site-config/index.html index c30382b2ea..7eb3d8a8ac 100644 --- a/docs/pt-BR/1.13.0/site-config/index.html +++ b/docs/pt-BR/1.13.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.13.0/translation.html b/docs/pt-BR/1.13.0/translation.html index 6b418f712f..066224bbc7 100644 --- a/docs/pt-BR/1.13.0/translation.html +++ b/docs/pt-BR/1.13.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Apresentando o Docusaurus --- diff --git a/docs/pt-BR/1.9.x/adding-blog/index.html b/docs/pt-BR/1.9.x/adding-blog/index.html index 70d4605e39..aad42ba7ed 100644 --- a/docs/pt-BR/1.9.x/adding-blog/index.html +++ b/docs/pt-BR/1.9.x/adding-blog/index.html @@ -94,7 +94,7 @@

Por exemplo, em website/blog/2017-08-18-Apresentando-o-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Apresentando o Docusaurus
 ---
diff --git a/docs/pt-BR/1.9.x/doc-markdown.html b/docs/pt-BR/1.9.x/doc-markdown.html
index 4eda8be777..7ff7b013cd 100644
--- a/docs/pt-BR/1.9.x/doc-markdown.html
+++ b/docs/pt-BR/1.9.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.9.x/doc-markdown/index.html b/docs/pt-BR/1.9.x/doc-markdown/index.html index 4eda8be777..7ff7b013cd 100644 --- a/docs/pt-BR/1.9.x/doc-markdown/index.html +++ b/docs/pt-BR/1.9.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -122,7 +122,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/1.9.x/docker.html b/docs/pt-BR/1.9.x/docker.html index d270a60f77..09ff8d3dd2 100644 --- a/docs/pt-BR/1.9.x/docker.html +++ b/docs/pt-BR/1.9.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.9.x/docker/index.html b/docs/pt-BR/1.9.x/docker/index.html index d270a60f77..09ff8d3dd2 100644 --- a/docs/pt-BR/1.9.x/docker/index.html +++ b/docs/pt-BR/1.9.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/1.9.x/publishing.html b/docs/pt-BR/1.9.x/publishing.html index d86811cd36..fa5d26ab57 100644 --- a/docs/pt-BR/1.9.x/publishing.html +++ b/docs/pt-BR/1.9.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + 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.

Usando o Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.9.x/publishing/index.html b/docs/pt-BR/1.9.x/publishing/index.html index d86811cd36..fa5d26ab57 100644 --- a/docs/pt-BR/1.9.x/publishing/index.html +++ b/docs/pt-BR/1.9.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + 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.

Usando o Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/1.9.x/site-config.html b/docs/pt-BR/1.9.x/site-config.html index 4feda88f27..0f440d6e31 100644 --- a/docs/pt-BR/1.9.x/site-config.html +++ b/docs/pt-BR/1.9.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.9.x/site-config/index.html b/docs/pt-BR/1.9.x/site-config/index.html index 4feda88f27..0f440d6e31 100644 --- a/docs/pt-BR/1.9.x/site-config/index.html +++ b/docs/pt-BR/1.9.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/1.9.x/translation.html b/docs/pt-BR/1.9.x/translation.html index bd5e607654..f5365c9442 100644 --- a/docs/pt-BR/1.9.x/translation.html +++ b/docs/pt-BR/1.9.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/pt-BR/adding-blog/index.html b/docs/pt-BR/adding-blog/index.html index 1c8277efc6..c1be440ea3 100644 --- a/docs/pt-BR/adding-blog/index.html +++ b/docs/pt-BR/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/pt-BR/doc-markdown.html b/docs/pt-BR/doc-markdown.html
index 247b1b4aa4..75df852918 100644
--- a/docs/pt-BR/doc-markdown.html
+++ b/docs/pt-BR/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -125,7 +125,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/doc-markdown/index.html b/docs/pt-BR/doc-markdown/index.html index 247b1b4aa4..75df852918 100644 --- a/docs/pt-BR/doc-markdown/index.html +++ b/docs/pt-BR/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -125,7 +125,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/docker.html b/docs/pt-BR/docker.html index 8bb79d0359..423a039624 100644 --- a/docs/pt-BR/docker.html +++ b/docs/pt-BR/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/docker/index.html b/docs/pt-BR/docker/index.html index 8bb79d0359..423a039624 100644 --- a/docs/pt-BR/docker/index.html +++ b/docs/pt-BR/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/next/adding-blog.html b/docs/pt-BR/next/adding-blog.html index a4595f8651..fe0721b3ab 100644 --- a/docs/pt-BR/next/adding-blog.html +++ b/docs/pt-BR/next/adding-blog.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/pt-BR/next/adding-blog/index.html b/docs/pt-BR/next/adding-blog/index.html
index a4595f8651..fe0721b3ab 100644
--- a/docs/pt-BR/next/adding-blog/index.html
+++ b/docs/pt-BR/next/adding-blog/index.html
@@ -95,7 +95,7 @@
 
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/pt-BR/next/doc-markdown.html b/docs/pt-BR/next/doc-markdown.html
index 353543b7c8..6763e834a7 100644
--- a/docs/pt-BR/next/doc-markdown.html
+++ b/docs/pt-BR/next/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -125,7 +125,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/next/doc-markdown/index.html b/docs/pt-BR/next/doc-markdown/index.html index 353543b7c8..6763e834a7 100644 --- a/docs/pt-BR/next/doc-markdown/index.html +++ b/docs/pt-BR/next/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Posts do blog

@@ -125,7 +125,7 @@
---
 title: Meu primeiro post de blog
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/pt-BR/next/docker.html b/docs/pt-BR/next/docker.html index 3a5a6e50d1..8ef4f92dc5 100644 --- a/docs/pt-BR/next/docker.html +++ b/docs/pt-BR/next/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/next/docker/index.html b/docs/pt-BR/next/docker/index.html index 3a5a6e50d1..8ef4f92dc5 100644 --- a/docs/pt-BR/next/docker/index.html +++ b/docs/pt-BR/next/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/pt-BR/next/publishing.html b/docs/pt-BR/next/publishing.html index 77994c7848..2d6010b186 100644 --- a/docs/pt-BR/next/publishing.html +++ b/docs/pt-BR/next/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -212,29 +212,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -263,12 +263,12 @@ # 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" + 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.

Usando o Travis CI

@@ -282,18 +282,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/next/publishing/index.html b/docs/pt-BR/next/publishing/index.html index 77994c7848..2d6010b186 100644 --- a/docs/pt-BR/next/publishing/index.html +++ b/docs/pt-BR/next/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -212,29 +212,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -263,12 +263,12 @@ # 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" + 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.

Usando o Travis CI

@@ -282,18 +282,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/next/site-config.html b/docs/pt-BR/next/site-config.html index 825da51fad..21449179f3 100644 --- a/docs/pt-BR/next/site-config.html +++ b/docs/pt-BR/next/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/next/site-config/index.html b/docs/pt-BR/next/site-config/index.html index 825da51fad..21449179f3 100644 --- a/docs/pt-BR/next/site-config/index.html +++ b/docs/pt-BR/next/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/next/translation.html b/docs/pt-BR/next/translation.html index 741495987d..adc499c310 100644 --- a/docs/pt-BR/next/translation.html +++ b/docs/pt-BR/next/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

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.

@@ -259,12 +259,12 @@ # 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" + 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.

Usando o Travis CI

@@ -278,18 +278,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/publishing/index.html b/docs/pt-BR/publishing/index.html index 928c25cd22..0ede81a0f8 100644 --- a/docs/pt-BR/publishing/index.html +++ b/docs/pt-BR/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -208,29 +208,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # Especifique aqui a versão desejada
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Fazendo deploy no GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Fazendo deploy no GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -259,12 +259,12 @@ # 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" + 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.

Usando o Travis CI

@@ -278,18 +278,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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.

Hosting on ZEIT Now

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

diff --git a/docs/pt-BR/site-config.html b/docs/pt-BR/site-config.html index 3b173169e2..65edc1e967 100644 --- a/docs/pt-BR/site-config.html +++ b/docs/pt-BR/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/site-config/index.html b/docs/pt-BR/site-config/index.html index 3b173169e2..65edc1e967 100644 --- a/docs/pt-BR/site-config/index.html +++ b/docs/pt-BR/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/pt-BR/translation.html b/docs/pt-BR/translation.html index 366d8d404c..95f7efddea 100644 --- a/docs/pt-BR/translation.html +++ b/docs/pt-BR/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Você pode passar aqui para aprender mais sobre como personalizar seu arquivo crowdin.yaml.

Configurando os scripts do Crowdin

@@ -258,40 +258,40 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # Especifique aqui a versão desejada - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Fazendo deploy no GitHub Pages - command: | + - checkout + - run: + name: Fazendo deploy no GitHub Pages + command: | git config --global user.email -"<GITHUB_USERNAME>@users.noreply.github.com" - git config --global user.name "<YOUR_NAME>" - echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc - # Instala o Docusaurus e gera o arquivo das strings em inglês - - cd website && yarn install && yarn run write-translations && cd .. - # Instala o Crowdin - - sudo apt-get install default-jre - - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb - - sudo dpkg -i crowdin.deb - # Faz o upload/download das traduções - - crowdin --config crowdin.yaml upload sources --auto-update -b master - - crowdin --config crowdin.yaml download -b master - # build and publish website - cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages +"<GITHUB_USERNAME>@users.noreply.github.com" + git config --global user.name "<YOUR_NAME>" + echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc + # Instala o Docusaurus e gera o arquivo das strings em inglês + - cd website && yarn install && yarn run write-translations && cd .. + # Instala o Crowdin + - sudo apt-get install default-jre + - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb + - sudo dpkg -i crowdin.deb + # Faz o upload/download das traduções + - crowdin --config crowdin.yaml upload sources --auto-update -b master + - crowdin --config crowdin.yaml download -b master + # build and publish website + cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages -workflows: - version: 2 - build_and_deploy: - jobs: +workflows: + version: 2 + build_and_deploy: + jobs: - - deploy-website: + - deploy-website: # filters: *filter-only-master

O comando crowdin usa o arquivo crowdin.yaml gerado pelo script examples. Ele deve ser colocado no diretório raiz do seu projeto para configurar como e quais arquivos serão enviados/baixados.

@@ -300,10 +300,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=SEU_ID_DE_PROJETO_CROWDIN CROWDIN_DOCUSAURUS_API_K

Caso você deseje usar o Crowdin localmente na sua máquina, você pode instalar a ferramenta de linha de comando do Crowdin e executar os mesmos comandos encontrados no arquivo circle.yaml. A única diferença é que você precisa definir os valores de project_identifier e api_key no arquivo crowdin.yaml, já que você não vai ter as variáveis de ambiente do Circle configuradas.

Traduções versionadas

Caso você deseje manter versões traduzidas para cada versão da sua documentação, adicione a seguinte seção ao fim do seu arquivo crowdin.yaml:

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

Documentos traduzidos e versionados serão copiados para website/translated_docs/${idioma}/${versão}/.

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ro/1.10.x/adding-blog/index.html b/docs/ro/1.10.x/adding-blog/index.html index 7a44303a68..647cc78d6e 100644 --- a/docs/ro/1.10.x/adding-blog/index.html +++ b/docs/ro/1.10.x/adding-blog/index.html @@ -94,7 +94,7 @@

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

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ro/1.10.x/doc-markdown.html b/docs/ro/1.10.x/doc-markdown.html
index 47d17de7a8..9f86014615 100644
--- a/docs/ro/1.10.x/doc-markdown.html
+++ b/docs/ro/1.10.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.10.x/doc-markdown/index.html b/docs/ro/1.10.x/doc-markdown/index.html index 47d17de7a8..9f86014615 100644 --- a/docs/ro/1.10.x/doc-markdown/index.html +++ b/docs/ro/1.10.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.10.x/docker.html b/docs/ro/1.10.x/docker.html index 421b47fd32..8186a0ad8f 100644 --- a/docs/ro/1.10.x/docker.html +++ b/docs/ro/1.10.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.10.x/docker/index.html b/docs/ro/1.10.x/docker/index.html index 421b47fd32..8186a0ad8f 100644 --- a/docs/ro/1.10.x/docker/index.html +++ b/docs/ro/1.10.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.10.x/publishing.html b/docs/ro/1.10.x/publishing.html index a31fb25d41..af956247c9 100644 --- a/docs/ro/1.10.x/publishing.html +++ b/docs/ro/1.10.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.10.x/publishing/index.html b/docs/ro/1.10.x/publishing/index.html index a31fb25d41..af956247c9 100644 --- a/docs/ro/1.10.x/publishing/index.html +++ b/docs/ro/1.10.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.10.x/site-config.html b/docs/ro/1.10.x/site-config.html index c03f30fcbb..a324ac6d3f 100644 --- a/docs/ro/1.10.x/site-config.html +++ b/docs/ro/1.10.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.10.x/site-config/index.html b/docs/ro/1.10.x/site-config/index.html index c03f30fcbb..a324ac6d3f 100644 --- a/docs/ro/1.10.x/site-config/index.html +++ b/docs/ro/1.10.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.10.x/translation.html b/docs/ro/1.10.x/translation.html index 283da647bf..7ebc23ac72 100644 --- a/docs/ro/1.10.x/translation.html +++ b/docs/ro/1.10.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ro/1.11.x/adding-blog/index.html b/docs/ro/1.11.x/adding-blog/index.html index f965aeeb39..958215ef3e 100644 --- a/docs/ro/1.11.x/adding-blog/index.html +++ b/docs/ro/1.11.x/adding-blog/index.html @@ -94,7 +94,7 @@

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

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ro/1.11.x/doc-markdown.html b/docs/ro/1.11.x/doc-markdown.html
index e6336fcefe..aa5b9980e0 100644
--- a/docs/ro/1.11.x/doc-markdown.html
+++ b/docs/ro/1.11.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.11.x/doc-markdown/index.html b/docs/ro/1.11.x/doc-markdown/index.html index e6336fcefe..aa5b9980e0 100644 --- a/docs/ro/1.11.x/doc-markdown/index.html +++ b/docs/ro/1.11.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.11.x/docker.html b/docs/ro/1.11.x/docker.html index 2652fd97bf..eeff1a25fb 100644 --- a/docs/ro/1.11.x/docker.html +++ b/docs/ro/1.11.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.11.x/docker/index.html b/docs/ro/1.11.x/docker/index.html index 2652fd97bf..eeff1a25fb 100644 --- a/docs/ro/1.11.x/docker/index.html +++ b/docs/ro/1.11.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.11.x/publishing.html b/docs/ro/1.11.x/publishing.html index f556f664a7..839e839d8e 100644 --- a/docs/ro/1.11.x/publishing.html +++ b/docs/ro/1.11.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.11.x/publishing/index.html b/docs/ro/1.11.x/publishing/index.html index f556f664a7..839e839d8e 100644 --- a/docs/ro/1.11.x/publishing/index.html +++ b/docs/ro/1.11.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.11.x/site-config.html b/docs/ro/1.11.x/site-config.html index 7d15979394..110f799f92 100644 --- a/docs/ro/1.11.x/site-config.html +++ b/docs/ro/1.11.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.11.x/site-config/index.html b/docs/ro/1.11.x/site-config/index.html index 7d15979394..110f799f92 100644 --- a/docs/ro/1.11.x/site-config/index.html +++ b/docs/ro/1.11.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.11.x/translation.html b/docs/ro/1.11.x/translation.html index 8cbbbd4712..00faa0910f 100644 --- a/docs/ro/1.11.x/translation.html +++ b/docs/ro/1.11.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ro/1.12.0/adding-blog/index.html b/docs/ro/1.12.0/adding-blog/index.html index 2ffc5aa796..1a64027ac2 100644 --- a/docs/ro/1.12.0/adding-blog/index.html +++ b/docs/ro/1.12.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ro/1.12.0/doc-markdown.html b/docs/ro/1.12.0/doc-markdown.html
index 16489ca3e2..0551f09e8f 100644
--- a/docs/ro/1.12.0/doc-markdown.html
+++ b/docs/ro/1.12.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.12.0/doc-markdown/index.html b/docs/ro/1.12.0/doc-markdown/index.html index 16489ca3e2..0551f09e8f 100644 --- a/docs/ro/1.12.0/doc-markdown/index.html +++ b/docs/ro/1.12.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.12.0/docker.html b/docs/ro/1.12.0/docker.html index 688d9635c9..00712eb772 100644 --- a/docs/ro/1.12.0/docker.html +++ b/docs/ro/1.12.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.12.0/docker/index.html b/docs/ro/1.12.0/docker/index.html index 688d9635c9..00712eb772 100644 --- a/docs/ro/1.12.0/docker/index.html +++ b/docs/ro/1.12.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.12.0/publishing.html b/docs/ro/1.12.0/publishing.html index b3c39c7453..2048573ce2 100644 --- a/docs/ro/1.12.0/publishing.html +++ b/docs/ro/1.12.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.12.0/publishing/index.html b/docs/ro/1.12.0/publishing/index.html index b3c39c7453..2048573ce2 100644 --- a/docs/ro/1.12.0/publishing/index.html +++ b/docs/ro/1.12.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.12.0/site-config.html b/docs/ro/1.12.0/site-config.html index 03874d328e..98075c655e 100644 --- a/docs/ro/1.12.0/site-config.html +++ b/docs/ro/1.12.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.12.0/site-config/index.html b/docs/ro/1.12.0/site-config/index.html index 03874d328e..98075c655e 100644 --- a/docs/ro/1.12.0/site-config/index.html +++ b/docs/ro/1.12.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.12.0/translation.html b/docs/ro/1.12.0/translation.html index 89fb6ea668..f3388b73a9 100644 --- a/docs/ro/1.12.0/translation.html +++ b/docs/ro/1.12.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ro/1.13.0/adding-blog/index.html b/docs/ro/1.13.0/adding-blog/index.html index 8701cd567a..c099517504 100644 --- a/docs/ro/1.13.0/adding-blog/index.html +++ b/docs/ro/1.13.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ro/1.13.0/doc-markdown.html b/docs/ro/1.13.0/doc-markdown.html
index a2a8ae7401..d09a357947 100644
--- a/docs/ro/1.13.0/doc-markdown.html
+++ b/docs/ro/1.13.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.13.0/doc-markdown/index.html b/docs/ro/1.13.0/doc-markdown/index.html index a2a8ae7401..d09a357947 100644 --- a/docs/ro/1.13.0/doc-markdown/index.html +++ b/docs/ro/1.13.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.13.0/docker.html b/docs/ro/1.13.0/docker.html index 40c72e15b2..19de761083 100644 --- a/docs/ro/1.13.0/docker.html +++ b/docs/ro/1.13.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.13.0/docker/index.html b/docs/ro/1.13.0/docker/index.html index 40c72e15b2..19de761083 100644 --- a/docs/ro/1.13.0/docker/index.html +++ b/docs/ro/1.13.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.13.0/publishing.html b/docs/ro/1.13.0/publishing.html index b34ba83fee..316e4ca348 100644 --- a/docs/ro/1.13.0/publishing.html +++ b/docs/ro/1.13.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.13.0/publishing/index.html b/docs/ro/1.13.0/publishing/index.html index b34ba83fee..316e4ca348 100644 --- a/docs/ro/1.13.0/publishing/index.html +++ b/docs/ro/1.13.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.13.0/site-config.html b/docs/ro/1.13.0/site-config.html index b60d33a223..53b28a44f4 100644 --- a/docs/ro/1.13.0/site-config.html +++ b/docs/ro/1.13.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.13.0/site-config/index.html b/docs/ro/1.13.0/site-config/index.html index b60d33a223..53b28a44f4 100644 --- a/docs/ro/1.13.0/site-config/index.html +++ b/docs/ro/1.13.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.13.0/translation.html b/docs/ro/1.13.0/translation.html index c419e87231..559bd35d38 100644 --- a/docs/ro/1.13.0/translation.html +++ b/docs/ro/1.13.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ro/1.9.x/adding-blog/index.html b/docs/ro/1.9.x/adding-blog/index.html index d6498f9c22..9153354c9d 100644 --- a/docs/ro/1.9.x/adding-blog/index.html +++ b/docs/ro/1.9.x/adding-blog/index.html @@ -94,7 +94,7 @@

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

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ro/1.9.x/doc-markdown.html b/docs/ro/1.9.x/doc-markdown.html
index 6fa3c14f56..57bccefb5a 100644
--- a/docs/ro/1.9.x/doc-markdown.html
+++ b/docs/ro/1.9.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.9.x/doc-markdown/index.html b/docs/ro/1.9.x/doc-markdown/index.html index 6fa3c14f56..57bccefb5a 100644 --- a/docs/ro/1.9.x/doc-markdown/index.html +++ b/docs/ro/1.9.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -122,7 +122,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/1.9.x/docker.html b/docs/ro/1.9.x/docker.html index bfe187ff0a..1fe21136d5 100644 --- a/docs/ro/1.9.x/docker.html +++ b/docs/ro/1.9.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.9.x/docker/index.html b/docs/ro/1.9.x/docker/index.html index bfe187ff0a..1fe21136d5 100644 --- a/docs/ro/1.9.x/docker/index.html +++ b/docs/ro/1.9.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/1.9.x/publishing.html b/docs/ro/1.9.x/publishing.html index fe875a0c9b..7015555f23 100644 --- a/docs/ro/1.9.x/publishing.html +++ b/docs/ro/1.9.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.9.x/publishing/index.html b/docs/ro/1.9.x/publishing/index.html index fe875a0c9b..7015555f23 100644 --- a/docs/ro/1.9.x/publishing/index.html +++ b/docs/ro/1.9.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/1.9.x/site-config.html b/docs/ro/1.9.x/site-config.html index c3c8bbd16d..f86ef24fd6 100644 --- a/docs/ro/1.9.x/site-config.html +++ b/docs/ro/1.9.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.9.x/site-config/index.html b/docs/ro/1.9.x/site-config/index.html index c3c8bbd16d..f86ef24fd6 100644 --- a/docs/ro/1.9.x/site-config/index.html +++ b/docs/ro/1.9.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/1.9.x/translation.html b/docs/ro/1.9.x/translation.html index 91396b2c15..f992e94f76 100644 --- a/docs/ro/1.9.x/translation.html +++ b/docs/ro/1.9.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ro/adding-blog/index.html b/docs/ro/adding-blog/index.html index 9ec882e49e..d6d33c2756 100644 --- a/docs/ro/adding-blog/index.html +++ b/docs/ro/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ro/doc-markdown.html b/docs/ro/doc-markdown.html
index 188ad4c3e5..28540f078f 100644
--- a/docs/ro/doc-markdown.html
+++ b/docs/ro/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -125,7 +125,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/doc-markdown/index.html b/docs/ro/doc-markdown/index.html index 188ad4c3e5..28540f078f 100644 --- a/docs/ro/doc-markdown/index.html +++ b/docs/ro/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -125,7 +125,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/docker.html b/docs/ro/docker.html index 51af9ca5c2..399b33e2eb 100644 --- a/docs/ro/docker.html +++ b/docs/ro/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/docker/index.html b/docs/ro/docker/index.html index 51af9ca5c2..399b33e2eb 100644 --- a/docs/ro/docker/index.html +++ b/docs/ro/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/next/adding-blog.html b/docs/ro/next/adding-blog.html index 3fcfc3e3fb..b576a6415a 100644 --- a/docs/ro/next/adding-blog.html +++ b/docs/ro/next/adding-blog.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ro/next/adding-blog/index.html b/docs/ro/next/adding-blog/index.html
index 3fcfc3e3fb..b576a6415a 100644
--- a/docs/ro/next/adding-blog/index.html
+++ b/docs/ro/next/adding-blog/index.html
@@ -95,7 +95,7 @@
 
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ro/next/doc-markdown.html b/docs/ro/next/doc-markdown.html
index 673e2fca8c..ed75a3facb 100644
--- a/docs/ro/next/doc-markdown.html
+++ b/docs/ro/next/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -125,7 +125,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/next/doc-markdown/index.html b/docs/ro/next/doc-markdown/index.html index 673e2fca8c..ed75a3facb 100644 --- a/docs/ro/next/doc-markdown/index.html +++ b/docs/ro/next/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Post-uri pentru Blog

@@ -125,7 +125,7 @@
---
 titlu: Prima mea post-are pe blog
 autor: Frank Li
-URLautor: http://twitter.com/franchementli
+URLautor: http://twitter.com/franchementli
 autorFBID: 100002976521003
 ---
 
diff --git a/docs/ro/next/docker.html b/docs/ro/next/docker.html index 04845ff01e..562d2d337d 100644 --- a/docs/ro/next/docker.html +++ b/docs/ro/next/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/next/docker/index.html b/docs/ro/next/docker/index.html index 04845ff01e..562d2d337d 100644 --- a/docs/ro/next/docker/index.html +++ b/docs/ro/next/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ro/next/publishing.html b/docs/ro/next/publishing.html index 579414f54e..b26cbfb5df 100644 --- a/docs/ro/next/publishing.html +++ b/docs/ro/next/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/next/publishing/index.html b/docs/ro/next/publishing/index.html index 579414f54e..b26cbfb5df 100644 --- a/docs/ro/next/publishing/index.html +++ b/docs/ro/next/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/next/site-config.html b/docs/ro/next/site-config.html index 8aced8faae..072ff86398 100644 --- a/docs/ro/next/site-config.html +++ b/docs/ro/next/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/next/site-config/index.html b/docs/ro/next/site-config/index.html index 8aced8faae..072ff86398 100644 --- a/docs/ro/next/site-config/index.html +++ b/docs/ro/next/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/next/translation.html b/docs/ro/next/translation.html index 6c1c75483c..918a84e86a 100644 --- a/docs/ro/next/translation.html +++ b/docs/ro/next/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/publishing/index.html b/docs/ro/publishing/index.html index d70034510d..c48a8f3302 100644 --- a/docs/ro/publishing/index.html +++ b/docs/ro/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/ro/site-config.html b/docs/ro/site-config.html index 91faa2fddd..ad8a63d1e3 100644 --- a/docs/ro/site-config.html +++ b/docs/ro/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/site-config/index.html b/docs/ro/site-config/index.html index 91faa2fddd..ad8a63d1e3 100644 --- a/docs/ro/site-config/index.html +++ b/docs/ro/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ro/translation.html b/docs/ro/translation.html index 385cb252c6..87691bbe20 100644 --- a/docs/ro/translation.html +++ b/docs/ro/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

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

Traduceri versionate

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

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ru/1.10.x/adding-blog/index.html b/docs/ru/1.10.x/adding-blog/index.html index 18a859632b..645ba9fb08 100644 --- a/docs/ru/1.10.x/adding-blog/index.html +++ b/docs/ru/1.10.x/adding-blog/index.html @@ -94,7 +94,7 @@

Например, website/blog/2017-08-18-Introducing-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ru/1.10.x/doc-markdown.html b/docs/ru/1.10.x/doc-markdown.html
index 5c0ed17fe9..575ac7f2ba 100644
--- a/docs/ru/1.10.x/doc-markdown.html
+++ b/docs/ru/1.10.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.10.x/doc-markdown/index.html b/docs/ru/1.10.x/doc-markdown/index.html index 5c0ed17fe9..575ac7f2ba 100644 --- a/docs/ru/1.10.x/doc-markdown/index.html +++ b/docs/ru/1.10.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.10.x/docker.html b/docs/ru/1.10.x/docker.html index 9cda12f821..ff29a83c67 100644 --- a/docs/ru/1.10.x/docker.html +++ b/docs/ru/1.10.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.10.x/docker/index.html b/docs/ru/1.10.x/docker/index.html index 9cda12f821..ff29a83c67 100644 --- a/docs/ru/1.10.x/docker/index.html +++ b/docs/ru/1.10.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.10.x/publishing.html b/docs/ru/1.10.x/publishing.html index 4d3b280f55..7fcc4e3ec8 100644 --- a/docs/ru/1.10.x/publishing.html +++ b/docs/ru/1.10.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.10.x/publishing/index.html b/docs/ru/1.10.x/publishing/index.html index 4d3b280f55..7fcc4e3ec8 100644 --- a/docs/ru/1.10.x/publishing/index.html +++ b/docs/ru/1.10.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.10.x/site-config.html b/docs/ru/1.10.x/site-config.html index 32db546f7f..046f267afe 100644 --- a/docs/ru/1.10.x/site-config.html +++ b/docs/ru/1.10.x/site-config.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.10.x/site-config/index.html b/docs/ru/1.10.x/site-config/index.html index 32db546f7f..046f267afe 100644 --- a/docs/ru/1.10.x/site-config/index.html +++ b/docs/ru/1.10.x/site-config/index.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.10.x/translation.html b/docs/ru/1.10.x/translation.html index 938672f0e2..f8d1fe062b 100644 --- a/docs/ru/1.10.x/translation.html +++ b/docs/ru/1.10.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ru/1.11.x/adding-blog/index.html b/docs/ru/1.11.x/adding-blog/index.html index 4946900d8e..af5c28ab99 100644 --- a/docs/ru/1.11.x/adding-blog/index.html +++ b/docs/ru/1.11.x/adding-blog/index.html @@ -94,7 +94,7 @@

Например, website/blog/2017-08-18-Introducing-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ru/1.11.x/doc-markdown.html b/docs/ru/1.11.x/doc-markdown.html
index c427fa438a..6e7e6fd476 100644
--- a/docs/ru/1.11.x/doc-markdown.html
+++ b/docs/ru/1.11.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.11.x/doc-markdown/index.html b/docs/ru/1.11.x/doc-markdown/index.html index c427fa438a..6e7e6fd476 100644 --- a/docs/ru/1.11.x/doc-markdown/index.html +++ b/docs/ru/1.11.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.11.x/docker.html b/docs/ru/1.11.x/docker.html index adf0f9c4bf..b9cf1e741e 100644 --- a/docs/ru/1.11.x/docker.html +++ b/docs/ru/1.11.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.11.x/docker/index.html b/docs/ru/1.11.x/docker/index.html index adf0f9c4bf..b9cf1e741e 100644 --- a/docs/ru/1.11.x/docker/index.html +++ b/docs/ru/1.11.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.11.x/publishing.html b/docs/ru/1.11.x/publishing.html index 47e0a60956..f82f1e3f95 100644 --- a/docs/ru/1.11.x/publishing.html +++ b/docs/ru/1.11.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.11.x/publishing/index.html b/docs/ru/1.11.x/publishing/index.html index 47e0a60956..f82f1e3f95 100644 --- a/docs/ru/1.11.x/publishing/index.html +++ b/docs/ru/1.11.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.11.x/site-config.html b/docs/ru/1.11.x/site-config.html index 6cad4df023..73809b5c6b 100644 --- a/docs/ru/1.11.x/site-config.html +++ b/docs/ru/1.11.x/site-config.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.11.x/site-config/index.html b/docs/ru/1.11.x/site-config/index.html index 6cad4df023..73809b5c6b 100644 --- a/docs/ru/1.11.x/site-config/index.html +++ b/docs/ru/1.11.x/site-config/index.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.11.x/translation.html b/docs/ru/1.11.x/translation.html index 29840d5e36..b1562aab0e 100644 --- a/docs/ru/1.11.x/translation.html +++ b/docs/ru/1.11.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Docusaurus
Docs
--- title: Представляем Docusaurus author: Джоэл Марси -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ru/1.12.0/adding-blog/index.html b/docs/ru/1.12.0/adding-blog/index.html index db0dc8de60..41b937da22 100644 --- a/docs/ru/1.12.0/adding-blog/index.html +++ b/docs/ru/1.12.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Представляем Docusaurus
 author: Джоэл Марси
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ru/1.12.0/doc-markdown.html b/docs/ru/1.12.0/doc-markdown.html
index 3108aa4768..3cf1fcfc5c 100644
--- a/docs/ru/1.12.0/doc-markdown.html
+++ b/docs/ru/1.12.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.12.0/doc-markdown/index.html b/docs/ru/1.12.0/doc-markdown/index.html index 3108aa4768..3cf1fcfc5c 100644 --- a/docs/ru/1.12.0/doc-markdown/index.html +++ b/docs/ru/1.12.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.12.0/docker.html b/docs/ru/1.12.0/docker.html index ee21a0701a..0b7d08edd4 100644 --- a/docs/ru/1.12.0/docker.html +++ b/docs/ru/1.12.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.12.0/docker/index.html b/docs/ru/1.12.0/docker/index.html index ee21a0701a..0b7d08edd4 100644 --- a/docs/ru/1.12.0/docker/index.html +++ b/docs/ru/1.12.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.12.0/publishing.html b/docs/ru/1.12.0/publishing.html index c570dc9748..ef28fea366 100644 --- a/docs/ru/1.12.0/publishing.html +++ b/docs/ru/1.12.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.12.0/publishing/index.html b/docs/ru/1.12.0/publishing/index.html index c570dc9748..ef28fea366 100644 --- a/docs/ru/1.12.0/publishing/index.html +++ b/docs/ru/1.12.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.12.0/site-config.html b/docs/ru/1.12.0/site-config.html index bdc42a9d7c..90b10a70e1 100644 --- a/docs/ru/1.12.0/site-config.html +++ b/docs/ru/1.12.0/site-config.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.12.0/site-config/index.html b/docs/ru/1.12.0/site-config/index.html index bdc42a9d7c..90b10a70e1 100644 --- a/docs/ru/1.12.0/site-config/index.html +++ b/docs/ru/1.12.0/site-config/index.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.12.0/translation.html b/docs/ru/1.12.0/translation.html index b9826a3f2c..dc079814b9 100644 --- a/docs/ru/1.12.0/translation.html +++ b/docs/ru/1.12.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Docusaurus
Docs
--- title: Представляем Docusaurus author: Джоэл Марси -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ru/1.13.0/adding-blog/index.html b/docs/ru/1.13.0/adding-blog/index.html index b76b9009f0..48d943ea26 100644 --- a/docs/ru/1.13.0/adding-blog/index.html +++ b/docs/ru/1.13.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Представляем Docusaurus
 author: Джоэл Марси
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ru/1.13.0/doc-markdown.html b/docs/ru/1.13.0/doc-markdown.html
index c36898ac70..b0a7850c0f 100644
--- a/docs/ru/1.13.0/doc-markdown.html
+++ b/docs/ru/1.13.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.13.0/doc-markdown/index.html b/docs/ru/1.13.0/doc-markdown/index.html index c36898ac70..b0a7850c0f 100644 --- a/docs/ru/1.13.0/doc-markdown/index.html +++ b/docs/ru/1.13.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.13.0/docker.html b/docs/ru/1.13.0/docker.html index 06f18e22d0..188e48eef7 100644 --- a/docs/ru/1.13.0/docker.html +++ b/docs/ru/1.13.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.13.0/docker/index.html b/docs/ru/1.13.0/docker/index.html index 06f18e22d0..188e48eef7 100644 --- a/docs/ru/1.13.0/docker/index.html +++ b/docs/ru/1.13.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.13.0/publishing.html b/docs/ru/1.13.0/publishing.html index e7d338f0d7..8fb1f99435 100644 --- a/docs/ru/1.13.0/publishing.html +++ b/docs/ru/1.13.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.13.0/publishing/index.html b/docs/ru/1.13.0/publishing/index.html index e7d338f0d7..8fb1f99435 100644 --- a/docs/ru/1.13.0/publishing/index.html +++ b/docs/ru/1.13.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.13.0/site-config.html b/docs/ru/1.13.0/site-config.html index f1a5b75703..41d118cfb2 100644 --- a/docs/ru/1.13.0/site-config.html +++ b/docs/ru/1.13.0/site-config.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.13.0/site-config/index.html b/docs/ru/1.13.0/site-config/index.html index f1a5b75703..41d118cfb2 100644 --- a/docs/ru/1.13.0/site-config/index.html +++ b/docs/ru/1.13.0/site-config/index.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.13.0/translation.html b/docs/ru/1.13.0/translation.html index 03d0ec6c6d..1d6ef8a3b9 100644 --- a/docs/ru/1.13.0/translation.html +++ b/docs/ru/1.13.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/ru/1.9.x/adding-blog/index.html b/docs/ru/1.9.x/adding-blog/index.html index 735740b791..09794654fd 100644 --- a/docs/ru/1.9.x/adding-blog/index.html +++ b/docs/ru/1.9.x/adding-blog/index.html @@ -94,7 +94,7 @@

Например, website/blog/2017-08-18-Introducing-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/ru/1.9.x/doc-markdown.html b/docs/ru/1.9.x/doc-markdown.html
index 2604dcbdd2..1361fc421f 100644
--- a/docs/ru/1.9.x/doc-markdown.html
+++ b/docs/ru/1.9.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.9.x/doc-markdown/index.html b/docs/ru/1.9.x/doc-markdown/index.html index 2604dcbdd2..1361fc421f 100644 --- a/docs/ru/1.9.x/doc-markdown/index.html +++ b/docs/ru/1.9.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -122,7 +122,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/1.9.x/docker.html b/docs/ru/1.9.x/docker.html index 101a4f6ad3..5b42d82724 100644 --- a/docs/ru/1.9.x/docker.html +++ b/docs/ru/1.9.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.9.x/docker/index.html b/docs/ru/1.9.x/docker/index.html index 101a4f6ad3..5b42d82724 100644 --- a/docs/ru/1.9.x/docker/index.html +++ b/docs/ru/1.9.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/1.9.x/publishing.html b/docs/ru/1.9.x/publishing.html index 619f869ff0..9f12f57a8b 100644 --- a/docs/ru/1.9.x/publishing.html +++ b/docs/ru/1.9.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.9.x/publishing/index.html b/docs/ru/1.9.x/publishing/index.html index 619f869ff0..9f12f57a8b 100644 --- a/docs/ru/1.9.x/publishing/index.html +++ b/docs/ru/1.9.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/1.9.x/site-config.html b/docs/ru/1.9.x/site-config.html index eb903f28ad..2aaf239ae4 100644 --- a/docs/ru/1.9.x/site-config.html +++ b/docs/ru/1.9.x/site-config.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.9.x/site-config/index.html b/docs/ru/1.9.x/site-config/index.html index eb903f28ad..2aaf239ae4 100644 --- a/docs/ru/1.9.x/site-config/index.html +++ b/docs/ru/1.9.x/site-config/index.html @@ -205,17 +205,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -223,10 +223,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/1.9.x/translation.html b/docs/ru/1.9.x/translation.html index 52584a26e9..8f01ce8e39 100644 --- a/docs/ru/1.9.x/translation.html +++ b/docs/ru/1.9.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Docusaurus
Docs
--- title: Представляем Docusaurus author: Джоэл Марси -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/ru/adding-blog/index.html b/docs/ru/adding-blog/index.html index 8ca5941b65..2d4c4b623b 100644 --- a/docs/ru/adding-blog/index.html +++ b/docs/ru/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Представляем Docusaurus
 author: Джоэл Марси
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ru/doc-markdown.html b/docs/ru/doc-markdown.html
index d5984e8ddb..1e0b2047c3 100644
--- a/docs/ru/doc-markdown.html
+++ b/docs/ru/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -125,7 +125,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/doc-markdown/index.html b/docs/ru/doc-markdown/index.html index d5984e8ddb..1e0b2047c3 100644 --- a/docs/ru/doc-markdown/index.html +++ b/docs/ru/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -125,7 +125,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/docker.html b/docs/ru/docker.html index 285a28326c..8677a49cd4 100644 --- a/docs/ru/docker.html +++ b/docs/ru/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/docker/index.html b/docs/ru/docker/index.html index 285a28326c..8677a49cd4 100644 --- a/docs/ru/docker/index.html +++ b/docs/ru/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/next/adding-blog.html b/docs/ru/next/adding-blog.html index 37917e2909..99b185854f 100644 --- a/docs/ru/next/adding-blog.html +++ b/docs/ru/next/adding-blog.html @@ -95,7 +95,7 @@
---
 title: Представляем Docusaurus
 author: Джоэл Марси
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ru/next/adding-blog/index.html b/docs/ru/next/adding-blog/index.html
index 37917e2909..99b185854f 100644
--- a/docs/ru/next/adding-blog/index.html
+++ b/docs/ru/next/adding-blog/index.html
@@ -95,7 +95,7 @@
 
---
 title: Представляем Docusaurus
 author: Джоэл Марси
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/ru/next/doc-markdown.html b/docs/ru/next/doc-markdown.html
index 65359c9168..4df88d1f0b 100644
--- a/docs/ru/next/doc-markdown.html
+++ b/docs/ru/next/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -125,7 +125,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/next/doc-markdown/index.html b/docs/ru/next/doc-markdown/index.html index 65359c9168..4df88d1f0b 100644 --- a/docs/ru/next/doc-markdown/index.html +++ b/docs/ru/next/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

Сообщения блога

@@ -125,7 +125,7 @@
---
 title: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/ru/next/docker.html b/docs/ru/next/docker.html index 15cf59d1c0..30c6bf8fce 100644 --- a/docs/ru/next/docker.html +++ b/docs/ru/next/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/next/docker/index.html b/docs/ru/next/docker/index.html index 15cf59d1c0..30c6bf8fce 100644 --- a/docs/ru/next/docker/index.html +++ b/docs/ru/next/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/ru/next/publishing.html b/docs/ru/next/publishing.html index 2b54bdcb5d..602b26e980 100644 --- a/docs/ru/next/publishing.html +++ b/docs/ru/next/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/next/publishing/index.html b/docs/ru/next/publishing/index.html index 2b54bdcb5d..602b26e980 100644 --- a/docs/ru/next/publishing/index.html +++ b/docs/ru/next/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/next/site-config.html b/docs/ru/next/site-config.html index 4839da605d..8ebfa3cc93 100644 --- a/docs/ru/next/site-config.html +++ b/docs/ru/next/site-config.html @@ -208,17 +208,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -226,10 +226,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/next/site-config/index.html b/docs/ru/next/site-config/index.html index 4839da605d..8ebfa3cc93 100644 --- a/docs/ru/next/site-config/index.html +++ b/docs/ru/next/site-config/index.html @@ -208,17 +208,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -226,10 +226,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/next/translation.html b/docs/ru/next/translation.html index e5d7829039..9e3b7a1b57 100644 --- a/docs/ru/next/translation.html +++ b/docs/ru/next/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/publishing/index.html b/docs/ru/publishing/index.html index bce79e6c3e..0d1e495206 100644 --- a/docs/ru/publishing/index.html +++ b/docs/ru/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # укажите здесь версию, которую желаете использовать
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "&lt;GITHUB_USERNAME&gt;@users.noreply.github.com"
             git config --global user.name "&lt;YOUR_NAME&gt;"
             echo "machine github.com login &lt;GITHUB_USERNAME&gt; password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=&lt;GIT_USER&gt; yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - deploy-website:
 #         filters: *filter-only-master
 

Обязательно замените все <....> в последовательности command: соответствующими значениями. Для &lt;GIT_USER&gt; это должна быть учетная запись GitHub, которая имеет доступ к записи документации в ваш репозиторий GitHub. В большинстве случаев &lt;GIT_USER&gt; и &lt;GITHUB_USERNAME&gt; имеют одинаковые значения.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

Сохраните этот файл как config.yml и разместите его в каталоге .circleci внутри вашего каталога website/static.

Использование Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

Теперь, когда новый коммит будет отправлен в master, Travis CI запустит набор тестов и, если все они будут пройдены, развернет ваш сайт с помощью сценария publish-gh-pages.

Hosting on ZEIT Now

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

diff --git a/docs/ru/site-config.html b/docs/ru/site-config.html index bbb2dae988..dc9f9745ca 100644 --- a/docs/ru/site-config.html +++ b/docs/ru/site-config.html @@ -208,17 +208,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -226,10 +226,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/site-config/index.html b/docs/ru/site-config/index.html index bbb2dae988..dc9f9745ca 100644 --- a/docs/ru/site-config/index.html +++ b/docs/ru/site-config/index.html @@ -208,17 +208,17 @@

Настройки подсветки синтаксиса:

{
   // ...
-  highlight: {
+  highlight: {
     // Наименование темы, используемой Highlight.js для подсветки кода.
     // Вы можете просмотреть список поддерживаемых тем здесь: 
     // https://github.com/isagalaev/highlight.js/tree/master/src/styles
-    theme: 'default',
+    theme: 'default',
 
     // Конкретная версия Highlight.js, которая будет использована.
-    version: '9.12.0',
+    version: '9.12.0',
 
     // Промежуточное звено для передачи экземпляра Highlight.js в функцию, указанную здесь, позволяет зарегистрировать дополнительные языки для подсветки.
-    hljs: function(highlightJsInstance) {
+    hljs: function(highlightJsInstance) {
       // ваш код
     },
 
@@ -226,10 +226,10 @@
     // Будет использован, если язык не указан в верхней части блока с кодом. Вы можете просмотреть список поддкрживаемых языков здесь:
     // https://github.com/isagalaev/highlight.js/tree/master/src/languages
 
-    defaultLang: 'javascript',
+    defaultLang: 'javascript',
 
     // пользовательский URL файла CSS с темой, которую вы желаете использовать в Highlight.js. Если указан, поля `theme` и `version` будут проигнорированы.
-    themeUrl: 'http://foo.bar/custom.css'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // Для URL github.io, используйте url и baseUrl следующим образом: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // Если ссылки в навигационном меню не требуются -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/ru/translation.html b/docs/ru/translation.html index d660cf65ef..ac9bbbdbe3 100644 --- a/docs/ru/translation.html +++ b/docs/ru/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Вы можете посмотреть здесь как настроить свой файл crowdin.yaml.

Настройка сценариев Crowdin

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # укажите версию для установки здесь - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # сборка и публикация сайта cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

Команда crowdin использует файл crowdin.yaml, созданный сценарием examples. Он должен быть размещен в каталоге вашего проекта для настройки того как файлы будут загружены/скачены.

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

Если вы желаете использовать Crowdin локально на своей машине, вы можете установить инструмент Crowdin CLI и запустить те же команды, что указаны в файле circle.yaml. Единственная различие состоит в том, что вы должны установить значения project_identifier и api_key в файле crowdin.yaml, так как у вас не будет настроенных переменных окружения из Circle.

Версионирование и перевод

Если вы желаете получить перевод для разных версий своей документации, добавьте следующий раздел в конец вашего файла crowdin.yaml:

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

Переведенные и версионированные документы будут размещены в каталоге website/translated_docs/${language}/${version}/.

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/zh-CN/1.10.x/adding-blog/index.html b/docs/zh-CN/1.10.x/adding-blog/index.html index d66e401dee..61511a8451 100644 --- a/docs/zh-CN/1.10.x/adding-blog/index.html +++ b/docs/zh-CN/1.10.x/adding-blog/index.html @@ -94,7 +94,7 @@

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/zh-CN/1.10.x/doc-markdown.html b/docs/zh-CN/1.10.x/doc-markdown.html
index e87a5239fb..658f9d6af9 100644
--- a/docs/zh-CN/1.10.x/doc-markdown.html
+++ b/docs/zh-CN/1.10.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.10.x/doc-markdown/index.html b/docs/zh-CN/1.10.x/doc-markdown/index.html index e87a5239fb..658f9d6af9 100644 --- a/docs/zh-CN/1.10.x/doc-markdown/index.html +++ b/docs/zh-CN/1.10.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.10.x/docker.html b/docs/zh-CN/1.10.x/docker.html index b043ed5a2d..40a66ec609 100644 --- a/docs/zh-CN/1.10.x/docker.html +++ b/docs/zh-CN/1.10.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.10.x/docker/index.html b/docs/zh-CN/1.10.x/docker/index.html index b043ed5a2d..40a66ec609 100644 --- a/docs/zh-CN/1.10.x/docker/index.html +++ b/docs/zh-CN/1.10.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.10.x/publishing.html b/docs/zh-CN/1.10.x/publishing.html index a4eabdbafc..7297820ac5 100644 --- a/docs/zh-CN/1.10.x/publishing.html +++ b/docs/zh-CN/1.10.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.10.x/publishing/index.html b/docs/zh-CN/1.10.x/publishing/index.html index a4eabdbafc..7297820ac5 100644 --- a/docs/zh-CN/1.10.x/publishing/index.html +++ b/docs/zh-CN/1.10.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.10.x/site-config.html b/docs/zh-CN/1.10.x/site-config.html index 8f8fb3a22b..5ac900201f 100644 --- a/docs/zh-CN/1.10.x/site-config.html +++ b/docs/zh-CN/1.10.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.10.x/site-config/index.html b/docs/zh-CN/1.10.x/site-config/index.html index 8f8fb3a22b..5ac900201f 100644 --- a/docs/zh-CN/1.10.x/site-config/index.html +++ b/docs/zh-CN/1.10.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -290,12 +290,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.10.x/translation.html b/docs/zh-CN/1.10.x/translation.html index a61ff840cc..a87ca5ed33 100644 --- a/docs/zh-CN/1.10.x/translation.html +++ b/docs/zh-CN/1.10.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/zh-CN/1.11.x/adding-blog/index.html b/docs/zh-CN/1.11.x/adding-blog/index.html index 01a44351c1..432cf58518 100644 --- a/docs/zh-CN/1.11.x/adding-blog/index.html +++ b/docs/zh-CN/1.11.x/adding-blog/index.html @@ -94,7 +94,7 @@

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/zh-CN/1.11.x/doc-markdown.html b/docs/zh-CN/1.11.x/doc-markdown.html
index d14f73ab22..5e70ae6f0b 100644
--- a/docs/zh-CN/1.11.x/doc-markdown.html
+++ b/docs/zh-CN/1.11.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.11.x/doc-markdown/index.html b/docs/zh-CN/1.11.x/doc-markdown/index.html index d14f73ab22..5e70ae6f0b 100644 --- a/docs/zh-CN/1.11.x/doc-markdown/index.html +++ b/docs/zh-CN/1.11.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.11.x/docker.html b/docs/zh-CN/1.11.x/docker.html index 215321532e..cd0745d15f 100644 --- a/docs/zh-CN/1.11.x/docker.html +++ b/docs/zh-CN/1.11.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.11.x/docker/index.html b/docs/zh-CN/1.11.x/docker/index.html index 215321532e..cd0745d15f 100644 --- a/docs/zh-CN/1.11.x/docker/index.html +++ b/docs/zh-CN/1.11.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.11.x/publishing.html b/docs/zh-CN/1.11.x/publishing.html index adb27be671..04f878c3b4 100644 --- a/docs/zh-CN/1.11.x/publishing.html +++ b/docs/zh-CN/1.11.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.11.x/publishing/index.html b/docs/zh-CN/1.11.x/publishing/index.html index adb27be671..04f878c3b4 100644 --- a/docs/zh-CN/1.11.x/publishing/index.html +++ b/docs/zh-CN/1.11.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.11.x/site-config.html b/docs/zh-CN/1.11.x/site-config.html index 4d85925a7d..8f06e3b299 100644 --- a/docs/zh-CN/1.11.x/site-config.html +++ b/docs/zh-CN/1.11.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.11.x/site-config/index.html b/docs/zh-CN/1.11.x/site-config/index.html index 4d85925a7d..8f06e3b299 100644 --- a/docs/zh-CN/1.11.x/site-config/index.html +++ b/docs/zh-CN/1.11.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.11.x/translation.html b/docs/zh-CN/1.11.x/translation.html index b107c8a3c2..076bf3c0e3 100644 --- a/docs/zh-CN/1.11.x/translation.html +++ b/docs/zh-CN/1.11.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/zh-CN/1.12.0/adding-blog/index.html b/docs/zh-CN/1.12.0/adding-blog/index.html index 760ff679ad..3a164a0768 100644 --- a/docs/zh-CN/1.12.0/adding-blog/index.html +++ b/docs/zh-CN/1.12.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/zh-CN/1.12.0/doc-markdown.html b/docs/zh-CN/1.12.0/doc-markdown.html
index 3819c51efd..d9eae948ce 100644
--- a/docs/zh-CN/1.12.0/doc-markdown.html
+++ b/docs/zh-CN/1.12.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.12.0/doc-markdown/index.html b/docs/zh-CN/1.12.0/doc-markdown/index.html index 3819c51efd..d9eae948ce 100644 --- a/docs/zh-CN/1.12.0/doc-markdown/index.html +++ b/docs/zh-CN/1.12.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.12.0/docker.html b/docs/zh-CN/1.12.0/docker.html index 38e0bffcbd..09b423b92a 100644 --- a/docs/zh-CN/1.12.0/docker.html +++ b/docs/zh-CN/1.12.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.12.0/docker/index.html b/docs/zh-CN/1.12.0/docker/index.html index 38e0bffcbd..09b423b92a 100644 --- a/docs/zh-CN/1.12.0/docker/index.html +++ b/docs/zh-CN/1.12.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.12.0/publishing.html b/docs/zh-CN/1.12.0/publishing.html index 363c2fb184..fae40cf435 100644 --- a/docs/zh-CN/1.12.0/publishing.html +++ b/docs/zh-CN/1.12.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.12.0/publishing/index.html b/docs/zh-CN/1.12.0/publishing/index.html index 363c2fb184..fae40cf435 100644 --- a/docs/zh-CN/1.12.0/publishing/index.html +++ b/docs/zh-CN/1.12.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.12.0/site-config.html b/docs/zh-CN/1.12.0/site-config.html index e99c94eb25..7be6b2deb8 100644 --- a/docs/zh-CN/1.12.0/site-config.html +++ b/docs/zh-CN/1.12.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.12.0/site-config/index.html b/docs/zh-CN/1.12.0/site-config/index.html index e99c94eb25..7be6b2deb8 100644 --- a/docs/zh-CN/1.12.0/site-config/index.html +++ b/docs/zh-CN/1.12.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.12.0/translation.html b/docs/zh-CN/1.12.0/translation.html index bf489bca7a..4a17462c3c 100644 --- a/docs/zh-CN/1.12.0/translation.html +++ b/docs/zh-CN/1.12.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/zh-CN/1.13.0/adding-blog/index.html b/docs/zh-CN/1.13.0/adding-blog/index.html index a7b1eeaf97..c38bdd8a18 100644 --- a/docs/zh-CN/1.13.0/adding-blog/index.html +++ b/docs/zh-CN/1.13.0/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/zh-CN/1.13.0/doc-markdown.html b/docs/zh-CN/1.13.0/doc-markdown.html
index 5d6b81c2aa..86646accca 100644
--- a/docs/zh-CN/1.13.0/doc-markdown.html
+++ b/docs/zh-CN/1.13.0/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.13.0/doc-markdown/index.html b/docs/zh-CN/1.13.0/doc-markdown/index.html index 5d6b81c2aa..86646accca 100644 --- a/docs/zh-CN/1.13.0/doc-markdown/index.html +++ b/docs/zh-CN/1.13.0/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.13.0/docker.html b/docs/zh-CN/1.13.0/docker.html index 7dbc73fe1d..47b2b40c70 100644 --- a/docs/zh-CN/1.13.0/docker.html +++ b/docs/zh-CN/1.13.0/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.13.0/docker/index.html b/docs/zh-CN/1.13.0/docker/index.html index 7dbc73fe1d..47b2b40c70 100644 --- a/docs/zh-CN/1.13.0/docker/index.html +++ b/docs/zh-CN/1.13.0/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.13.0/publishing.html b/docs/zh-CN/1.13.0/publishing.html index e6c3569dfd..e10472636d 100644 --- a/docs/zh-CN/1.13.0/publishing.html +++ b/docs/zh-CN/1.13.0/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.13.0/publishing/index.html b/docs/zh-CN/1.13.0/publishing/index.html index e6c3569dfd..e10472636d 100644 --- a/docs/zh-CN/1.13.0/publishing/index.html +++ b/docs/zh-CN/1.13.0/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.13.0/site-config.html b/docs/zh-CN/1.13.0/site-config.html index 7aa7f98d48..2fa66a5211 100644 --- a/docs/zh-CN/1.13.0/site-config.html +++ b/docs/zh-CN/1.13.0/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.13.0/site-config/index.html b/docs/zh-CN/1.13.0/site-config/index.html index 7aa7f98d48..2fa66a5211 100644 --- a/docs/zh-CN/1.13.0/site-config/index.html +++ b/docs/zh-CN/1.13.0/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -300,12 +300,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.13.0/translation.html b/docs/zh-CN/1.13.0/translation.html index c6b727ef09..362a8da553 100644 --- a/docs/zh-CN/1.13.0/translation.html +++ b/docs/zh-CN/1.13.0/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- author: Frank Li -authorURL: https://twitter.com/foobarbaz +authorURL: https://twitter.com/foobarbaz authorFBID: 503283835 title: Introducing Docusaurus --- diff --git a/docs/zh-CN/1.9.x/adding-blog/index.html b/docs/zh-CN/1.9.x/adding-blog/index.html index 11e86930ae..edd109f80e 100644 --- a/docs/zh-CN/1.9.x/adding-blog/index.html +++ b/docs/zh-CN/1.9.x/adding-blog/index.html @@ -94,7 +94,7 @@

例如, 文件 website/blog/2017-08-18-Introducing-Docusaurus.md:

---
 author: Frank Li
-authorURL: https://twitter.com/foobarbaz
+authorURL: https://twitter.com/foobarbaz
 authorFBID: 503283835
 title: Introducing Docusaurus
 ---
diff --git a/docs/zh-CN/1.9.x/doc-markdown.html b/docs/zh-CN/1.9.x/doc-markdown.html
index 9531f25b61..eda2733aae 100644
--- a/docs/zh-CN/1.9.x/doc-markdown.html
+++ b/docs/zh-CN/1.9.x/doc-markdown.html
@@ -109,7 +109,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.9.x/doc-markdown/index.html b/docs/zh-CN/1.9.x/doc-markdown/index.html index 9531f25b61..eda2733aae 100644 --- a/docs/zh-CN/1.9.x/doc-markdown/index.html +++ b/docs/zh-CN/1.9.x/doc-markdown/index.html @@ -109,7 +109,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -122,7 +122,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/1.9.x/docker.html b/docs/zh-CN/1.9.x/docker.html index 361b7a2171..fe6eae66d3 100644 --- a/docs/zh-CN/1.9.x/docker.html +++ b/docs/zh-CN/1.9.x/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.9.x/docker/index.html b/docs/zh-CN/1.9.x/docker/index.html index 361b7a2171..fe6eae66d3 100644 --- a/docs/zh-CN/1.9.x/docker/index.html +++ b/docs/zh-CN/1.9.x/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/1.9.x/publishing.html b/docs/zh-CN/1.9.x/publishing.html index 35fffa82bd..74e5554fee 100644 --- a/docs/zh-CN/1.9.x/publishing.html +++ b/docs/zh-CN/1.9.x/publishing.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.9.x/publishing/index.html b/docs/zh-CN/1.9.x/publishing/index.html index 35fffa82bd..74e5554fee 100644 --- a/docs/zh-CN/1.9.x/publishing/index.html +++ b/docs/zh-CN/1.9.x/publishing/index.html @@ -139,7 +139,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -206,29 +206,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -257,12 +257,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -276,18 +276,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/1.9.x/site-config.html b/docs/zh-CN/1.9.x/site-config.html index 433dd8df8d..0f818ba06b 100644 --- a/docs/zh-CN/1.9.x/site-config.html +++ b/docs/zh-CN/1.9.x/site-config.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.9.x/site-config/index.html b/docs/zh-CN/1.9.x/site-config/index.html index 433dd8df8d..0f818ba06b 100644 --- a/docs/zh-CN/1.9.x/site-config/index.html +++ b/docs/zh-CN/1.9.x/site-config/index.html @@ -205,17 +205,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -223,10 +223,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -288,12 +288,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/1.9.x/translation.html b/docs/zh-CN/1.9.x/translation.html index 61a7957ad2..38a059cbb9 100644 --- a/docs/zh-CN/1.9.x/translation.html +++ b/docs/zh-CN/1.9.x/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

Docusaurus
Docs
--- title: Introducing Docusaurus author: Joel Marcey -authorURL: http://twitter.com/JoelMarcey +authorURL: http://twitter.com/JoelMarcey authorFBID: 611217057 authorTwitter: JoelMarcey --- diff --git a/docs/zh-CN/adding-blog/index.html b/docs/zh-CN/adding-blog/index.html index 7fbcba3c12..f97c26beca 100644 --- a/docs/zh-CN/adding-blog/index.html +++ b/docs/zh-CN/adding-blog/index.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/zh-CN/doc-markdown.html b/docs/zh-CN/doc-markdown.html
index f0ca321df3..e3e638d71c 100644
--- a/docs/zh-CN/doc-markdown.html
+++ b/docs/zh-CN/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -125,7 +125,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/doc-markdown/index.html b/docs/zh-CN/doc-markdown/index.html index f0ca321df3..e3e638d71c 100644 --- a/docs/zh-CN/doc-markdown/index.html +++ b/docs/zh-CN/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -125,7 +125,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/docker.html b/docs/zh-CN/docker.html index 2260268ccc..1549cc5800 100644 --- a/docs/zh-CN/docker.html +++ b/docs/zh-CN/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/docker/index.html b/docs/zh-CN/docker/index.html index 2260268ccc..1549cc5800 100644 --- a/docs/zh-CN/docker/index.html +++ b/docs/zh-CN/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/next/adding-blog.html b/docs/zh-CN/next/adding-blog.html index 7862712f3f..81a28dc0b7 100644 --- a/docs/zh-CN/next/adding-blog.html +++ b/docs/zh-CN/next/adding-blog.html @@ -95,7 +95,7 @@
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/zh-CN/next/adding-blog/index.html b/docs/zh-CN/next/adding-blog/index.html
index 7862712f3f..81a28dc0b7 100644
--- a/docs/zh-CN/next/adding-blog/index.html
+++ b/docs/zh-CN/next/adding-blog/index.html
@@ -95,7 +95,7 @@
 
---
 title: Introducing Docusaurus
 author: Joel Marcey
-authorURL: http://twitter.com/JoelMarcey
+authorURL: http://twitter.com/JoelMarcey
 authorFBID: 611217057
 authorTwitter: JoelMarcey
 ---
diff --git a/docs/zh-CN/next/doc-markdown.html b/docs/zh-CN/next/doc-markdown.html
index 607153fdb8..b78215aaae 100644
--- a/docs/zh-CN/next/doc-markdown.html
+++ b/docs/zh-CN/next/doc-markdown.html
@@ -112,7 +112,7 @@
 
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -125,7 +125,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/next/doc-markdown/index.html b/docs/zh-CN/next/doc-markdown/index.html index 607153fdb8..b78215aaae 100644 --- a/docs/zh-CN/next/doc-markdown/index.html +++ b/docs/zh-CN/next/doc-markdown/index.html @@ -112,7 +112,7 @@
---
 id: doc-markdown
 title: Markdown Features
-custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
+custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
 

博客文章

@@ -125,7 +125,7 @@
---
 tittle: My First Blog Post
 author: Frank Li
-authorURL: http://twitter.com/franchementli
+authorURL: http://twitter.com/franchementli
 authorFBID: 100002976521003
 ---
 
diff --git a/docs/zh-CN/next/docker.html b/docs/zh-CN/next/docker.html index 9ea58e22c4..ddac3dfc32 100644 --- a/docs/zh-CN/next/docker.html +++ b/docs/zh-CN/next/docker.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/next/docker/index.html b/docs/zh-CN/next/docker/index.html index 9ea58e22c4..ddac3dfc32 100644 --- a/docs/zh-CN/next/docker/index.html +++ b/docs/zh-CN/next/docker/index.html @@ -108,22 +108,22 @@
version: "3"
 
 services:
-  docusaurus:
-    build: .
-    ports:
+  docusaurus:
+    build: .
+    ports:
 
-      - 3000:3000
-      - 35729:35729
-    volumes:
-      - ./docs:/app/docs
-      - ./website/blog:/app/website/blog
-      - ./website/core:/app/website/core
-      - ./website/i18n:/app/website/i18n
-      - ./website/pages:/app/website/pages
-      - ./website/static:/app/website/static
-      - ./website/sidebars.json:/app/website/sidebars.json
-      - ./website/siteConfig.js:/app/website/siteConfig.js
-    working_dir: /app/website
+      - 3000:3000
+      - 35729:35729
+    volumes:
+      - ./docs:/app/docs
+      - ./website/blog:/app/website/blog
+      - ./website/core:/app/website/core
+      - ./website/i18n:/app/website/i18n
+      - ./website/pages:/app/website/pages
+      - ./website/static:/app/website/static
+      - ./website/sidebars.json:/app/website/sidebars.json
+      - ./website/siteConfig.js:/app/website/siteConfig.js
+    working_dir: /app/website
 
 

To run a local web server with docker-compose run docker-compose up.

diff --git a/docs/zh-CN/next/publishing.html b/docs/zh-CN/next/publishing.html index 441c4e7f29..cf259c3d4d 100644 --- a/docs/zh-CN/next/publishing.html +++ b/docs/zh-CN/next/publishing.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/next/publishing/index.html b/docs/zh-CN/next/publishing/index.html index 441c4e7f29..cf259c3d4d 100644 --- a/docs/zh-CN/next/publishing/index.html +++ b/docs/zh-CN/next/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -211,29 +211,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -262,12 +262,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -281,18 +281,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/next/site-config.html b/docs/zh-CN/next/site-config.html index bf3471bd47..a60f55f867 100644 --- a/docs/zh-CN/next/site-config.html +++ b/docs/zh-CN/next/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/next/site-config/index.html b/docs/zh-CN/next/site-config/index.html index bf3471bd47..a60f55f867 100644 --- a/docs/zh-CN/next/site-config/index.html +++ b/docs/zh-CN/next/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/next/translation.html b/docs/zh-CN/next/translation.html index bb7813c155..301920e650 100644 --- a/docs/zh-CN/next/translation.html +++ b/docs/zh-CN/next/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/publishing/index.html b/docs/zh-CN/publishing/index.html index ad196b98d4..14b48acfc5 100644 --- a/docs/zh-CN/publishing/index.html +++ b/docs/zh-CN/publishing/index.html @@ -140,7 +140,7 @@
const siteConfig = {
   ...
   url: 'https://__userName__.github.io', // Your website URL
-  baseUrl: '/testProject/',
+  baseUrl: '/testProject/',
   projectName: 'testProject',
   organizationName: 'userName'
   ...
@@ -207,29 +207,29 @@
 
 version: 2
 jobs:
-  deploy-website:
-    docker:
+  deploy-website:
+    docker:
       # specify the version you desire here
 
-      - image: circleci/node:8.11.1
+      - image: circleci/node:8.11.1
 
-    steps:
+    steps:
 
-      - checkout
-      - run:
-          name: Deploying to GitHub Pages
-          command: |
+      - checkout
+      - run:
+          name: Deploying to GitHub Pages
+          command: |
             git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com"
             git config --global user.name "<YOUR_NAME>"
             echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc
             cd website && yarn install && GIT_USER=<GIT_USER> yarn run publish-gh-pages
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
 
-workflows:
-  version: 2
-  build_and_deploy:
-    jobs:
-
-      - deploy-website:
+      - 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.

@@ -258,12 +258,12 @@ # 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" + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch"

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

Using Travis CI

@@ -277,18 +277,18 @@
# .travis.yml
 language: node_js
 node_js:
-  - '8'
+  - '8'
 branches:
-  only:
-    - master
+  only:
+    - master
 cache:
-  yarn: true
+  yarn: true
 script:
-  - git config --global user.name "${GH_NAME}"
-  - git config --global user.email "${GH_EMAIL}"
-  - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
-
+ - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +

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

Hosting on ZEIT Now

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

diff --git a/docs/zh-CN/site-config.html b/docs/zh-CN/site-config.html index 6bc614d587..3b0e51156d 100644 --- a/docs/zh-CN/site-config.html +++ b/docs/zh-CN/site-config.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/site-config/index.html b/docs/zh-CN/site-config/index.html index 6bc614d587..3b0e51156d 100644 --- a/docs/zh-CN/site-config/index.html +++ b/docs/zh-CN/site-config/index.html @@ -208,17 +208,17 @@

Syntax highlighting options:

{
   // ...
-  highlight: {
+  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',
+    theme: 'default',
 
     // The particular version of Highlight.js to be used.
-    version: '9.12.0',
+    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) {
+    hljs: function(highlightJsInstance) {
       // do something here
     },
 
@@ -226,10 +226,10 @@
     // 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',
+    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'
+    themeUrl: 'http://foo.bar/custom.css'
   },
 }
 
@@ -311,12 +311,12 @@ // For github.io type URLS, you would combine the URL and baseUrl like: // url: 'https://reasonml.github.io', // baseUrl: '/reason-react/', - defaultVersionShown: '1.0.0', + defaultVersionShown: '1.0.0', organizationName: 'facebook', projectName: 'docusaurus', noIndex: false, // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [ + headerLinks: [ {doc: 'doc1', label: 'Docs'}, {page: 'help', label: 'Help'}, {search: true}, diff --git a/docs/zh-CN/translation.html b/docs/zh-CN/translation.html index 6a186539c2..567ef1d956 100644 --- a/docs/zh-CN/translation.html +++ b/docs/zh-CN/translation.html @@ -208,20 +208,20 @@ languages.js preserve_hierarchy: true files: - - - source: '/docs/**/*.md' - translation: '/website/translated_docs/%locale%/**/%original_file_name%' - languages_mapping: &anchor - locale: - 'de': 'de' - 'es-ES': 'es-ES' - 'fr': 'fr' - 'ja': 'ja' - 'ko': 'ko' - 'mr': 'mr-IN' - 'pt-BR': 'pt-BR' - 'zh-CN': 'zh-CN' - 'zh-TW': 'zh-TW' + - + source: '/docs/**/*.md' + translation: '/website/translated_docs/%locale%/**/%original_file_name%' + languages_mapping: &anchor + locale: + 'de': 'de' + 'es-ES': 'es-ES' + 'fr': 'fr' + 'ja': 'ja' + 'ko': 'ko' + 'mr': 'mr-IN' + 'pt-BR': 'pt-BR' + 'zh-CN': 'zh-CN' + 'zh-TW': 'zh-TW'

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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

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

Setup the Crowdin Scripts

@@ -257,18 +257,18 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY version: 2 jobs: - deploy-website: - docker: + deploy-website: + docker: # specify the version you desire here - - image: circleci/node:8.11.1 + - image: circleci/node:8.11.1 - steps: + steps: - - checkout - - run: - name: Deploying to GitHub Pages - command: | + - checkout + - run: + name: Deploying to GitHub Pages + command: | git config --global user.email "<GITHUB_USERNAME>@users.noreply.github.com" git config --global user.name "<YOUR_NAME>" echo "machine github.com login <GITHUB_USERNAME> password $GITHUB_TOKEN" > ~/.netrc @@ -283,13 +283,13 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY - crowdin --config crowdin.yaml download -b master # build and publish website cd website && GIT_USER=<GIT_USER> yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: -workflows: - version: 2 - build_and_deploy: - jobs: - - - deploy-website: + - deploy-website: # filters: *filter-only-master

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

@@ -298,10 +298,10 @@ CROWDIN_DOCUSAURUS_PROJECT_ID=YOUR_CROWDIN_PROJECT_ID CROWDIN_DOCUSAURUS_API_KEY

If you wish to use Crowdin on your machine locally, you can install the Crowdin CLI tool and run the same commands found in the circle.yaml file. The only difference is that you must set project_identifier and api_key values in the crowdin.yaml file since you will not have Circle environment variables set up.

版本翻译

If you wish to have translation and versioning for your documentation, add the following section to the end of your crowdin.yaml file:

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

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